Follow the links below to browse sample Javadoc for MJ classes and tools, including the MJ Runtime Library.
Handler that defines entity for data tuples found in a Mapper report.
Classes and Interfaces | |
AnnotatedColumnDef | Database column definition that is annotated with the associated, source Mapper report column name and type. |
DataEntityHandler | Handler that defines entity (i.e., table) for data tuples found in a Mapper report. |
public class com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef
extends com.arsi.mj.config.atoms.ColumnDef
Constructors |
Public ctor for initializing an instance of this class.
public AnnotatedColumnDef(java.lang.String aMapperCanonicalName, com.arsi.mj.datatype.MaprptDataType aMapperDataType, com.arsi.mj.config.atoms.ColumnDef aColumnDef)
|
Public ctor for initializing an instance of this class.
public AnnotatedColumnDef(java.lang.String aMapperCanonicalName, com.arsi.mj.datatype.MaprptDataType aMapperDataType, java.lang.String anEntityAttributeName, java.lang.String aColumnName, int aLength, boolean aNullableFlag, org.hibernate.type.BasicType aHibernateType)
|
Public ctor for initializing an instance of this class.
public AnnotatedColumnDef(java.lang.String aMapperCanonicalName, com.arsi.mj.datatype.MaprptDataType aMapperDataType, java.lang.String anEntityAttributeName, java.lang.String aColumnName, int aLength, int aScale, boolean aNullableFlag, org.hibernate.type.BasicType aHibernateType)
|
Methods |
public boolean equals(java.lang.Object anObject)
|
Get canonical name (without spaces) of column in Mapper report.
public final java.lang.String getMaprptCanonicalName()
|
Get data type of column in Mapper report.
public final com.arsi.mj.datatype.MaprptDataType getMaprptDataType()
|
public int hashCode()
|
Set canonical name (without spaces) of column in Mapper report.
public final void setMaprptCanonicalName(java.lang.String aName)
|
Set data type of column in Mapper report.
public final void setMaprptDataType(com.arsi.mj.datatype.MaprptDataType aDataType)
|
public class com.arsi.mj.maprpt.entity.handler.DataEntityHandler
extends java.lang.Object
Constructors |
public DataEntityHandler()
|
Methods |
Get first binary find key for entity, if any. As the name implies, a binary
find key defines entity columns referred to by Mapper BFN command(s)
and has implications for entity indexing, and traversal and DML of rows in key order.When the only one set of entity columns is referred to by the Mapper BFN
command in a translated application, use the primaryKey attribute to define
the key instead of a binary find key.
public com.arsi.mj.maprpt.entity.keydef.BinaryFindKeyDef getBinaryFindKey1()
|
public com.arsi.mj.maprpt.entity.keydef.BinaryFindKeyDef getBinaryFindKey2()
|
public com.arsi.mj.maprpt.entity.keydef.BinaryFindKeyDef getBinaryFindKey3()
|
Get binary find keys for this entity.
public java.util.List getBinaryFindKeys()
|
Get definition of column 1.
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn1()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn10()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn11()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn12()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn13()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn14()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn15()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn16()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn17()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn18()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn19()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn2()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn20()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn21()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn22()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn23()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn24()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn25()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn3()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn4()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn5()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn6()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn7()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn8()
|
public final com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef getColumn9()
|
Get ordinal column number of specified annotated column definition.
public java.lang.Integer getColumnOrdinal(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColdef)
|
Get column definitions that comprise this data entity.
public java.util.List getColumns()
|
Get custom name to use for creation time stamp column.
public java.lang.String getCreateTimestampColumnName()
|
Get custom name to use for created-by-user column.
public java.lang.String getCreateUserColumnName()
|
Get suffix to append to persistent Hibernate class to arrive at persistent base class name.
public java.lang.String getEntityBaseClassSuffix()
|
Get name of entity class, i.e., persistent Hibernate class.
public java.lang.String getEntityClassName()
|
Get suffix to append to persistent Hibernate class to arrive at manager class name.
public java.lang.String getEntityManagerClassSuffix()
|
Get name of Java package where entity class resides.
public java.lang.String getEntityPackageName()
|
Get mapping that translates line types of data lines in the source Mapper report
to enumerated constants and stores in a database column in the entity table. The
lineTypeColumn and lineTypeDefaultValue attributes must
also be set if the line type enumeration mapping is set.
public com.arsi.mj.maprpt.enums.LineTypeEnumMapping getEnumerateLineTypeAsColumn()
|
Get mapping that translates report numbers of source Mapper reports
to enumerated constants and stores in a database column in the entity table. The
reportNumberColumn and reportNumberDefaultValue attributes must
also be set if the report range enumeration mapping is set.This mapping is mutually exclusive of the enumerateReportNumberAsColumn
mapping, i.e., either one or the other may be defined, but not both.
public com.arsi.mj.maprpt.enums.ReportNumberEnumMapping getEnumerateReportNumberAsColumn()
|
Get mapping that translates ranges of report numbers of source Mapper reports
to enumerated constants and stores in a database column in the entity table. The
reportRangeColumn and reportRangeDefaultValue attributes must
also be set if the report range enumeration mapping is set.This mapping is mutually exclusive of the enumerateReportNumberAsColumn
mapping, i.e., either one or the other may be defined, but not both.
public com.arsi.mj.maprpt.enums.ReportRangeEnumMapping getEnumerateReportRangeAsColumn()
|
Get enumeration for column 1.
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn1()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn10()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn11()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn12()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn13()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn14()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn15()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn16()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn17()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn18()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn19()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn2()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn20()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn21()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn22()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn23()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn24()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn25()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn3()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn4()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn5()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn6()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn7()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn8()
|
public final com.arsi.mj.maprpt.enums.StringKeyEnumMapping getEnumForColumn9()
|
public final java.util.Map getEnums()
|
Get first foreign key for entity, if any. A foreign key defines an association
with other translated data entities and is implemented as One-to-Many ,
Many-to-One or One-to-One relationship.
public com.arsi.mj.maprpt.entity.keydef.ForeignKeyDef getForeignKey1()
|
public com.arsi.mj.maprpt.entity.keydef.ForeignKeyDef getForeignKey2()
|
public com.arsi.mj.maprpt.entity.keydef.ForeignKeyDef getForeignKey3()
|
Get foreign keys for this entity.
public java.util.List getForeignKeys()
|
Get definition of column that stores enumerated constants mapped from line types.
The column must not allow NULLs, the column type must be compatible with String
(StringType ) and the column length must accommodate all enumeration values.
public com.arsi.mj.config.atoms.ColumnDef getLineTypeColumn()
|
Get default enumerated constant value to insert into column mapped from line type
in cases where no value has been provided for this column.
public java.lang.String getLineTypeDefaultValue()
|
Get natural primary key for entity, if any. The primary key is defined by
column(s) in the table that serve as a business identifier, with the introduction
of a sequence number if needed to ensure uniqueness. The surrogate key used as
an identity by Hibernate (i.e., id ) is different from the primary key
defined by this method.The primary key is used as a binary find key when the entity columns in the key are referred to by Mapper BFN command(s). If columns in the
entity other than those in the primary key are referenced by various BFN
commands (unusual but possible), define one or more binary find keys in addition
to the natural primary key.
public com.arsi.mj.maprpt.entity.keydef.PrimaryKeyDef getPrimaryKey()
|
Get definition of column that stores enumerated constants mapped from report numbers.
The column must not allow NULLs, the column type must be compatible with String
(StringType ) and the column length must accommodate all enumeration values.
public com.arsi.mj.config.atoms.ColumnDef getReportNumberColumn()
|
Get default enumerated constant value to insert into column mapped from
report number in cases where no value has been provided for this column.
public java.lang.String getReportNumberDefaultValue()
|
Get definition of column that stores enumerated constants mapped from report ranges.
The column must not allow NULLs, the column type must be compatible with String
(StringType ) and the column length must accommodate all enumeration values.
public com.arsi.mj.config.atoms.ColumnDef getReportRangeColumn()
|
Get default enumerated constant value to insert into column mapped from line type
in cases where no value has been provided for this column.
public java.lang.String getReportRangeDefaultValue()
|
Get name to use for surrogate key (Hibernate id ) column.
public java.lang.String getSurrogateKeyColumnName()
|
Get name of database sequence (or equivalent) for generating surrogate key (Hibernate id ).
public java.lang.String getSurrogateKeySequenceName()
|
Get name of database table defined for entity.
public java.lang.String getTableName()
|
Get custom name to use for last update time stamp column.
public java.lang.String getUpdateTimestampColumnName()
|
Get custom name to use for last-updated-by-user column.
public java.lang.String getUpdateUserColumnName()
|
Set the first binary find key for entity.
public void setBinaryFindKey1(com.arsi.mj.maprpt.entity.keydef.BinaryFindKeyDef aKeyDef)
|
public void setBinaryFindKey2(com.arsi.mj.maprpt.entity.keydef.BinaryFindKeyDef aKeyDef)
|
public void setBinaryFindKey3(com.arsi.mj.maprpt.entity.keydef.BinaryFindKeyDef aKeyDef)
|
Set binary find keys for this entity.
public void setBinaryFindKeys(java.util.List someKeyDefs)
|
Set definition of column 1.
public final void setColumn1(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn10(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn11(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn12(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn13(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn14(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn15(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn16(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn17(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn18(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn19(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn2(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn20(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn21(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn22(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn23(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn24(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn25(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn3(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn4(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn5(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn6(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn7(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn8(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
public final void setColumn9(com.arsi.mj.maprpt.entity.handler.AnnotatedColumnDef aColumnDef)
|
Set column definitions that comprise this data entity.
public void setColumns(java.util.List someColumnDefs)
|
Set custom name to use for creation time stamp column.
public void setCreateTimestampColumnName(java.lang.String aName)
|
Set custom name to use for created-by-user column.
public void setCreateUserColumnName(java.lang.String aName)
|
Set suffix to append to persistent Hibernate class to arrive at persistent base class name.
public void setEntityBaseClassSuffix(java.lang.String aSuffix)
|
Set name of entity class, i.e., persistent Hibernate class.
public void setEntityClassName(java.lang.String aName)
|
Set suffix to append to persistent Hibernate class to arrive at manager class name.
public void setEntityManagerClassSuffix(java.lang.String aSuffix)
|
Set name of Java package where entity class resides.
public void setEntityPackageName(java.lang.String aName)
|
Set mapping that translates line types to enumerated constants and stores in a
database column in the entity table.
public void setEnumerateLineTypeAsColumn(com.arsi.mj.maprpt.enums.LineTypeEnumMapping anEnumMapping)
|
Set mapping that translates report ranges to enumerated constants and stores in a
database column in the entity table.
public void setEnumerateReportNumberAsColumn(com.arsi.mj.maprpt.enums.ReportNumberEnumMapping anEnumMapping)
|
Set mapping that translates report ranges to enumerated constants and stores in a
database column in the entity table.
public void setEnumerateReportRangeAsColumn(com.arsi.mj.maprpt.enums.ReportRangeEnumMapping anEnumMapping)
|
Set enumeration for column 1. All possible values of the database column (except for
NULL) must be encompassed by the values in the enumeration mapping, the type of the
column must be compatible with String (CharacterArrayType ,
CharacterType or StringType ) and the column length must
accommodate all enumeration values.
public final void setEnumForColumn1(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn10(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn11(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn12(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn13(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn14(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn15(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn16(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn17(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn18(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn19(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn2(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn20(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn21(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn22(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn23(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn24(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn25(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn3(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn4(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn5(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn6(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn7(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn8(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
public final void setEnumForColumn9(com.arsi.mj.maprpt.enums.StringKeyEnumMapping anEnum)
|
Set the first foreign key for entity.
public void setForeignKey1(com.arsi.mj.maprpt.entity.keydef.ForeignKeyDef aKeyDef)
|
public void setForeignKey2(com.arsi.mj.maprpt.entity.keydef.ForeignKeyDef aKeyDef)
|
public void setForeignKey3(com.arsi.mj.maprpt.entity.keydef.ForeignKeyDef aKeyDef)
|
Set foreign keys for this entity.
public void setForeignKeys(java.util.List someKeyDefs)
|
Set definition of column that stores enumerated constants mapped from line types.
public void setLineTypeColumn(com.arsi.mj.config.atoms.ColumnDef aColdef)
|
Set default enumerated constant value to insert into column mapped from line type
in cases where no value has been provided for this column.
public void setLineTypeDefaultValue(java.lang.String anEnumValue)
|
Set the natural primary key for entity. If a converted application that make use of
this entity must remain dependent on line numbers when performing DML, a primary key
that consists solely of a sequence number (which acts as a kind of line number)
is permitted.
public void setPrimaryKey(com.arsi.mj.maprpt.entity.keydef.PrimaryKeyDef aKeyDef)
|
Set definition of column that stores enumerated constants mapped from report numbers.
public void setReportNumberColumn(com.arsi.mj.config.atoms.ColumnDef aColdef)
|
Set default enumerated constant value to insert into column mapped from report
number in cases where no value has been provided for this column.
public void setReportNumberDefaultValue(java.lang.String anEnumValue)
|
Set definition of column that stores enumerated constants mapped from line types.
public void setReportRangeColumn(com.arsi.mj.config.atoms.ColumnDef aColdef)
|
Set default enumerated constant value to insert into column mapped from line type
in cases where no value has been provided for this column.
public void setReportRangeDefaultValue(java.lang.String anEnumValue)
|
Set name to use for surrogate key (Hibernate id ) column.
public void setSurrogateKeyColumnName(java.lang.String aName)
|
Set name of database sequence (or equivalent) for generating surrogate key (Hibernate id ).
public void setSurrogateKeySequenceName(java.lang.String aName)
|
Set name of database table defined for entity.
public void setTableName(java.lang.String aName)
|
Set custom name to use for last update time stamp column.
public void setUpdateTimestampColumnName(java.lang.String aName)
|
Set custom name to use for last-updated-by-user column.
public void setUpdateUserColumnName(java.lang.String aName)
|
public void validate()
|