er.taggable.migrations

Class ERTaggableEntity0

java.lang.Object

er.extensions.migration.ERXMigrationDatabase.Migration

er.taggable.migrations.ERTaggableEntity0

All Implemented Interfaces:

IERXMigration

public class ERTaggableEntity0
extends ERXMigrationDatabase.Migration

ERTaggableEntity0 provides a superclass for creating the join table for your taggable entities.

Author:

mschrag

Field Summary

Fields inherited from class er.extensions.migration.ERXMigrationDatabase.Migration

ALLOWS_NULL, NOT_NULL

Constructor Summary

Constructors

Constructor and Description
ERTaggableEntity0(String entityName) Constructs an ERTaggableEntity0.
ERTaggableEntity0(String entityName, String tagsRelationshipName) Constructs an ERTaggableEntity0.
ERTaggableEntity0(String entityName, String tagsRelationshipName, String tagEntityName) Constructs an ERTaggableEntity0.

Method Summary

Modifier and Type	Method and Description
void	downgrade(EOEditingContext editingContext, ERXMigrationDatabase database)
NSArray<ERXModelVersion>	modelDependencies() Overridden to return null by default
static void	upgrade(EOEditingContext editingContext, EOAdaptorChannel channel, EOModel model, String itemEntityName)
static void	upgrade(EOEditingContext editingContext, EOAdaptorChannel channel, EOModel model, String itemEntityName, String tagsRelationshipName)
static void	upgrade(EOEditingContext editingContext, EOAdaptorChannel channel, EOModel model, String entityName, String tagsRelationshipName, String tagEntityName) If you don't want to subclass ERTaggableEntity0, you can call this static method from your own migration.
void	upgrade(EOEditingContext editingContext, ERXMigrationDatabase database)

Methods inherited from class er.extensions.migration.ERXMigrationDatabase.Migration

downgrade, languages, upgrade

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ERTaggableEntity0

public ERTaggableEntity0(String entityName)

Constructs an ERTaggableEntity0.

Parameters:

entityName - the name of your entity to tag

ERTaggableEntity0

public ERTaggableEntity0(String entityName,
                         String tagsRelationshipName)

Constructs an ERTaggableEntity0.

Parameters:

entityName - the name of your entity to tag

tagsRelationshipName - the name of the flattened to-many relationship to ERTag (defaults to "tags")

ERTaggableEntity0

public ERTaggableEntity0(String entityName,
                         String tagsRelationshipName,
                         String tagEntityName)

Constructs an ERTaggableEntity0.

Parameters:

entityName - the name of your entity to tag

tagsRelationshipName - the name of the flattened to-many relationship to ERTag (defaults to "tags")

tagEntityName - the name of the tag entity (defaults to "ERTag")

Method Detail

modelDependencies

public NSArray<ERXModelVersion> modelDependencies()

Description copied from class: ERXMigrationDatabase.Migration

Overridden to return null by default

Specified by:

modelDependencies in interface IERXMigration

Overrides:

modelDependencies in class ERXMigrationDatabase.Migration

Returns:

an array of model versions that this migration depends on

downgrade

public void downgrade(EOEditingContext editingContext,
                      ERXMigrationDatabase database)
               throws Throwable

Specified by:

downgrade in class ERXMigrationDatabase.Migration

Parameters:

editingContext - the editing context

database - the migration database

Throws:

Throwable - if anything goes wrong

See Also:

IERXMigration.downgrade(EOEditingContext, EOAdaptorChannel, EOModel)

upgrade

public void upgrade(EOEditingContext editingContext,
                    ERXMigrationDatabase database)
             throws Throwable

Specified by:

upgrade in class ERXMigrationDatabase.Migration

Parameters:

editingContext - the editing context

database - the migration database

Throws:

Throwable - if anything goes wrong

See Also:

IERXMigration.upgrade(EOEditingContext, EOAdaptorChannel, EOModel)

upgrade

public static void upgrade(EOEditingContext editingContext,
                           EOAdaptorChannel channel,
                           EOModel model,
                           String itemEntityName)
                    throws SQLException

Throws:

SQLException

upgrade

public static void upgrade(EOEditingContext editingContext,
                           EOAdaptorChannel channel,
                           EOModel model,
                           String itemEntityName,
                           String tagsRelationshipName)
                    throws SQLException

Throws:

SQLException

upgrade

public static void upgrade(EOEditingContext editingContext,
                           EOAdaptorChannel channel,
                           EOModel model,
                           String entityName,
                           String tagsRelationshipName,
                           String tagEntityName)
                    throws SQLException

If you don't want to subclass ERTaggableEntity0, you can call this static method from your own migration.

Parameters:

editingContext - the editing context

channel - the adaptor channel

model - the model

entityName - the name of your entity to tag

tagsRelationshipName - the name of the flattened to-many relationship to ERTag (defaults to "tags")

tagEntityName - the name of the tag entity (defaults to "ERTag")

Throws:

SQLException - if the update script fails