Follow the links below to browse sample Javadoc for MJ classes and tools, including the MJ Runtime Library.

 

Package: com.arsi.mj.maprpt.entity.keydef  previous next contents

Defines keys for data entity handlers.

Classes and Interfaces
BinaryFindKeyDef Defines a binary-find key for a data entity handler to support access to entity equivalent to that provided by the BFN Mapper command.
DataEntityKeyDef Abstract base class for data entity key definitions.
ForeignKeyDef Defines the foreign key for a data entity handler.
PrimaryKeyDef Defines the natural primary key for a data entity handler.

Class: BinaryFindKeyDef   next package

Defines a binary-find key for a data entity handler to support access to entity equivalent to that provided by the BFN Mapper command. Essentially this key definition is treated as an index declaration, augmented by a custom-generated ID if the sequence number column is included.
Treat this class as "thread-safe" when used as intended, since an instance is not modified after initialization, but "thread-hostile" if changes are made after creating the class by concurrent threads since none of the methods are synchronized.

public abstract class com.arsi.mj.maprpt.entity.keydef.BinaryFindKeyDef
  extends com.arsi.mj.maprpt.entity.keydef.DataEntityKeyDef
Constructors
public BinaryFindKeyDef()
Methods
Get name of sequence number column introduced to permit ordered access.
Returns:
name of sequence number column, or NULL to if not applicable or to use default column name.
public java.lang.String getSeqnumColumn()
Get gap between sequence numbers introduced to permit ordered access.
Returns:
gap between sequence numbers, or -1 if not applicable or to use default gap.
public int getSeqnumGap()
Determines if sequence number column should be introduced to permit ordered access by an equivalent of line number.
Returns:
true to introduce sequence number column, false if no introduction.
public boolean isSeqnumIncluded()
Set name of sequence number column introduced to permit ordered access, if applicable.
Parameters:
aColumnName - name of sequence number column.
public void setSeqnumColumn(java.lang.String aColumnName)
Set gap between sequence numbers introduced to permit ordered access, if applicable.
Parameters:
aGap - gap between sequence numbers.
public void setSeqnumGap(int aGap)
Indicate that a sequence number column should be introduced to permit ordered access by an equivalent of line number, which certain uses of BFN may require.
Parameters:
aIncludeSeqnumFlag - true to introduce sequence number column, false if sequence number column is not needed.
public void setSeqnumIncluded(boolean aIncludeSeqnumFlag)

Class: DataEntityKeyDef   previous next package

Abstract base class for data entity key definitions.
Treat this class as "thread-safe" when used as intended, since an instance is not modified after initialization, but "thread-hostile" if changes are made after creating the class by concurrent threads since none of the methods are synchronized.

public abstract class com.arsi.mj.maprpt.entity.keydef.DataEntityKeyDef
  extends java.lang.Object
Constructors
public DataEntityKeyDef()
Methods
Get entity attributes that comprise this key definition.
Returns:
list of attribute names.
public java.util.List attributes()
Set attribute 1 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute1()
Set attribute 10 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute10()
Set attribute 2 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute2()
Set attribute 3 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute3()
Set attribute 4 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute4()
Set attribute 5 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute5()
Set attribute 6 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute6()
Set attribute 7 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute7()
Set attribute 8 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute8()
Set attribute 9 as the name of an entity attribute referenced in a DataEntityHandler.
Returns:
the attribute name.
public java.lang.String getEntityAttribute9()
Get name assigned to key definition. The name must be unique within the larger translated Mapper application, as it may be used to generate database index names or other artifact names.
Returns:
name of key definition.
public java.lang.String getKeydefName()
Set attribute 1 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute1(java.lang.String anAttributeName)
Set attribute 10 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute10(java.lang.String anAttributeName)
Set attribute 2 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute2(java.lang.String anAttributeName)
Set attribute 3 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute3(java.lang.String anAttributeName)
Set attribute 4 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute4(java.lang.String anAttributeName)
Set attribute 5 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute5(java.lang.String anAttributeName)
Set attribute 6 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute6(java.lang.String anAttributeName)
Set attribute 7 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute7(java.lang.String anAttributeName)
Set attribute 8 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute8(java.lang.String anAttributeName)
Set attribute 9 as the name of an entity attribute referenced in a DataEntityHandler.
Parameters:
anAttributeName - an attribute name.
public void setEntityAttribute9(java.lang.String anAttributeName)
Set name assigned to key definition.
Parameters:
anAttributeName - name of key definition.
public void setKeydefName(java.lang.String aName)

Class: ForeignKeyDef   previous next package

Defines the foreign key for a data entity handler.
Treat this class as "thread-safe" when used as intended, since an instance is not modified after initialization, but "thread-hostile" if changes are made after creating the class by concurrent threads since none of the methods are synchronized.

public class com.arsi.mj.maprpt.entity.keydef.ForeignKeyDef
  extends java.lang.Object
Constructors
public ForeignKeyDef()
Methods
Get foreign columns that comprise this key definition.
Returns:
list of column names.
public java.util.List foreignColumns()
Get column 1 as the name of a column referenced in foreign DataEntityHandler.
Returns:
the foreign column name.
public java.lang.String getForeignColumn1()
Get column 10 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn10()
Get column 2 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn2()
Get column 3 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn3()
Get column 4 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn4()
Get column 5 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn5()
Get column 6 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn6()
Get column 7 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn7()
Get column 8 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn8()
Get column 9 as the name of a column referenced in a DataEntityHandler.
Returns:
the column name.
public java.lang.String getForeignColumn9()
Get name of table this foreign key references.
Returns:
name of foreign table.
public java.lang.String getForeignTable()
Set column 1 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn1(java.lang.String aColumnName)
Set column 10 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn10(java.lang.String aColumnName)
Set column 2 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn2(java.lang.String aColumnName)
Set column 3 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn3(java.lang.String aColumnName)
Set column 4 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn4(java.lang.String aColumnName)
Set column 5 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn5(java.lang.String aColumnName)
Set column 6 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn6(java.lang.String aColumnName)
Set column 7 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn7(java.lang.String aColumnName)
Set column 8 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn8(java.lang.String aColumnName)
Set column 9 as the name of a column referenced in a DataEntityHandler.
Parameters:
aColumnName - a column name.
public void setForeignColumn9(java.lang.String aColumnName)
Set name of table this foreign key references; a DataEntityHandler must be defined for this table which is accessible from the DataEntityHandler defined for the target table.
Parameters:
aColumnName - name of foreign table.
public void setForeignTable(java.lang.String aTableName)

Class: PrimaryKeyDef   previous package

Defines the natural primary key for a data entity handler. All columns specified must not allow NULLs. TO handle oddities in legacy data, the defined key columns do not necessarily have to form a unique key on their own; if this is this case, a sequence number column must be introduced to ensure uniqueness.
Treat this class as "thread-safe" when used as intended, since an instance is not modified after initialization, but "thread-hostile" if changes are made after creating the class by concurrent threads since none of the methods are synchronized.

public abstract class com.arsi.mj.maprpt.entity.keydef.PrimaryKeyDef
  extends com.arsi.mj.maprpt.entity.keydef.DataEntityKeyDef
Constructors
public PrimaryKeyDef()
Methods
Get name of sequence number column introduced to ensure uniqueness.
Returns:
name of sequence number column, or NULL to if not applicable or to use default column name.
public java.lang.String getSeqnumColumn()
Get gap between sequence numbers introduced to ensure uniqueness.
Returns:
gap between sequence numbers, or -1 if not applicable or to use default gap.
public int getSeqnumGap()
Determines if sequence number column should be introduced for positional access and DML. Whether this sequence number column is included or not, it is assumed that the other columns form a unique key on their own (use setSeqnumIncludedForUniqueness if the other columns aren't unique).
Returns:
true to introduce sequence number column for positional access and DML, false if no introduction.
public boolean isSeqnumIncludedForPosition()
Determines if sequence number column should be introduced to ensure uniqueness of other key columns. Without this sequence number column, it is assumed that the other columns form a unique key on their own.
Returns:
true to introduce sequence number column to ensure uniqueness, false if no introduction.
public boolean isSeqnumIncludedForUniqueness()
Set name of sequence number column introduced to ensure uniqueness, if applicable.
Parameters:
aColumnName - name of sequence number column.
public void setSeqnumColumn(java.lang.String aColumnName)
Set gap between sequence numbers introduced to ensure uniqueness, if applicable.
Parameters:
aGap - gap between sequence numbers.
public void setSeqnumGap(int aGap)
Indicate that a sequence number column should be introduced for positional access and DML.
Parameters:
aIncludeSeqnumFlag - true to introduce sequence number column, false if sequence number column is not needed for positional access and DML.
public void setSeqnumIncludedForPosition(boolean aIncludeSeqnumFlag)
Indicate that a sequence number column should be introduced to ensure uniqueness of other key columns, as is expected of a primary key.
Parameters:
aIncludeSeqnumFlag - true to introduce sequence number column, false if sequence number column is not needed to ensure uniqueness.
public void setSeqnumIncludedForUniqueness(boolean aIncludeSeqnumFlag)