public class TableInfo extends CachedObjectPointer implements Entity
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CACHE_NAME |
static int |
MT_DELTA_TABLE |
static int |
MT_DELTA2_TABLE |
static int |
MT_LANDLORDONLY_TABLE |
static int |
MT_SYSTEM_TABLE |
static int |
MT_TEMPLATE_TABLE |
static int |
MT_TEMPLATE2_TABLE |
static int |
MT_TENANT_TABLE |
Modifier and Type | Method and Description |
---|---|
void |
addColumnInfo(TableColumnInfo columnInfo)
Adds column information to this table information.
|
void |
addMLInUseColumn()
Increase the number of multi-language in use columns of this table.
|
java.lang.String |
getAltIxName()
Get the alternate index name of this table.
|
java.lang.String |
getAuditTable(java.lang.String tableName)
Returns audit table associated with this table, if any.
|
java.lang.String |
getCacheName() |
TableColumnInfo |
getColumnInfo(java.lang.String columnName)
Returns column information in a TableColumnInfo object
for the given column name, if the column name exists for this
table, otherwise returns null.
|
java.lang.String |
getColumnName(java.lang.String entityColumnName)
Returns the column name for the given entity column name.
|
java.lang.String |
getColumnName(java.lang.String entityColumnName,
java.lang.String tableName)
Returns the column name for the given entity column name and table name.
|
java.util.Iterator |
getColumns()
Returns an Iterator to iterate over columns of this table.
|
java.util.Iterator |
getColumns(java.lang.String tableName)
Returns an Iterator to iterate over columns of this table.
|
java.lang.String |
getContentAttrName()
Get the content attribute name for this table.
|
java.lang.String |
getEAuditTableName()
Returns the audit table name in which the audit record information
is written.
|
java.lang.String |
getEntityColumnName(java.lang.String tableColumnName,
java.lang.String tableName)
Returns the entity column name for the given table column name and table name.
|
java.util.Iterator |
getEntityColumns()
Returns an Iterator to iterate over columns of this table.
|
java.lang.String |
getExtTableName()
Returns the name of the table.
|
java.util.Iterator |
getKeyColumns()
Returns an Iterator to iterate over key column names.
|
java.util.Iterator |
getKeyColumns(java.lang.String tableName)
Returns an Iterator to iterate over key column names.
|
java.lang.String |
getLangColumnName()
Returns the Unique Column name for which sequence is created
|
java.lang.String |
getLangColumnName(java.lang.String tableName)
Returns the Language Column name
This method is provided to support the Entity interface.
|
java.lang.String |
getLangTBName()
Get the language table name of this table.
|
java.lang.String |
getMLParent() |
RowStampInfo |
getRowStampInfo()
Returns rowstamp information for this table, if rowstamp
column exists.
|
int |
getStorageType() |
int |
getTableCount()
Returns the number of tables associated with this object.
|
java.lang.String |
getTableName()
Returns the name of the table.
|
java.lang.String |
getTableName(java.lang.String entityColumnName)
Returns the table name for the given column name.
|
java.util.Iterator |
getTables()
Returns an Iterator to iterate over table name.
|
java.util.Iterator |
getTablesInHierarchyOrder()
Returns an Iterator to iterate over table name.
|
java.util.Iterator |
getTablesInReverseHierarchyOrder()
Returns an Iterator to iterate over table name in reverse
hierarchy order.
|
TenantIdInfo |
getTenantIdInfo()
Returns tenantif information related to this entity.
|
TableInfoBase |
getTypedReference() |
TableInfoBase |
getTypedReferenceForSet() |
java.lang.String |
getUniqueColumnName()
Get the unqiue column name of this table.
|
boolean |
hasImplicitTenantId()
Returns whether the entity has tenantid or not for any of the participating tables.
|
boolean |
hasImplicitTenantId(java.lang.String tableName)
Returns whether the entity has tenantid or not for the table
tableName . |
boolean |
hasRowStamp()
Returns whether rowstamp information exists for this table or not.
|
boolean |
isMLInUse()
Whether the table's multi-language support is being used
|
boolean |
isRowStampColumnExists()
Returns whether rowstamp column exists for this table or not.
|
boolean |
isTenantOwned() |
boolean |
isTextSearchEnabled()
returns whether this table is text search enabled or not
|
boolean |
isUsedForAuditing()
Returns whether this table is used for auditing.
|
boolean |
isUsedForMLang()
Return whether the table is the language table for multi-lang support
|
void |
removeMLInUseColumn()
Decrease the number of multi-language in use columns of this table.
|
getClonedInfo, getID, getParent, getReference, getReferenceForSet, isSameTenantAsReference, setID, setParent, setReference, setTenantReference
public static final java.lang.String CACHE_NAME
public static final int MT_TENANT_TABLE
public static final int MT_DELTA_TABLE
public static final int MT_SYSTEM_TABLE
public static final int MT_TEMPLATE_TABLE
public static final int MT_LANDLORDONLY_TABLE
public static final int MT_TEMPLATE2_TABLE
public static final int MT_DELTA2_TABLE
public java.lang.String getEAuditTableName()
public boolean isUsedForAuditing()
public boolean isUsedForMLang()
public boolean isRowStampColumnExists()
public java.lang.String getTableName()
public java.lang.String getExtTableName()
public boolean isTextSearchEnabled()
public java.util.Iterator getTables()
getTables
in interface Entity
Entity.getTables()
public int getTableCount()
getTableCount
in interface Entity
Entity.getTableCount()
public java.util.Iterator getTablesInHierarchyOrder()
getTablesInHierarchyOrder
in interface Entity
Entity.getTablesInHierarchyOrder()
public java.util.Iterator getTablesInReverseHierarchyOrder()
getTablesInReverseHierarchyOrder
in interface Entity
Entity.getTablesInReverseHierarchyOrder()
public java.lang.String getTableName(java.lang.String entityColumnName)
getTableName
in interface Entity
entityColumnName
- column nameEntity.getTableName(java.lang.String)
public java.lang.String getColumnName(java.lang.String entityColumnName)
getColumnName
in interface Entity
entityColumnName
- column nameEntity.getColumnName(java.lang.String)
public java.lang.String getColumnName(java.lang.String entityColumnName, java.lang.String tableName)
getColumnName
in interface Entity
entityColumnName
- entity column nametableName
- table nameEntity.getColumnName(java.lang.String,
java.lang.String)
public java.lang.String getEntityColumnName(java.lang.String tableColumnName, java.lang.String tableName)
getEntityColumnName
in interface Entity
tableColumnName
- table column nametableName
- table nameEntity.getEntityColumnName(java.lang.String,
java.lang.String)
public RowStampInfo getRowStampInfo()
getRowStampInfo
in interface Entity
Entity.getRowStampInfo()
public TenantIdInfo getTenantIdInfo()
Entity
getTenantIdInfo
in interface Entity
public boolean hasRowStamp()
hasRowStamp
in interface Entity
Entity.hasRowStamp()
public java.lang.String getAuditTable(java.lang.String tableName)
getAuditTable
in interface Entity
Entity.getAuditTable(java.lang.String)
public java.lang.String getLangTBName()
public void addMLInUseColumn()
public void removeMLInUseColumn()
public boolean isMLInUse()
public java.lang.String getUniqueColumnName()
public java.lang.String getContentAttrName()
public java.lang.String getAltIxName()
public java.lang.String getLangColumnName()
public java.lang.String getLangColumnName(java.lang.String tableName)
getLangColumnName
in interface Entity
public int getStorageType()
public java.lang.String getMLParent()
public boolean hasImplicitTenantId(java.lang.String tableName)
Entity
tableName
.hasImplicitTenantId
in interface Entity
public boolean hasImplicitTenantId()
Entity
hasImplicitTenantId
in interface Entity
public void addColumnInfo(TableColumnInfo columnInfo)
columnInfo
- column information to be added.public TableColumnInfo getColumnInfo(java.lang.String columnName)
columnName
- name of the column for which additional information
is needed.public java.util.Iterator getKeyColumns()
public java.util.Iterator getColumns()
public java.util.Iterator getEntityColumns()
getEntityColumns
in interface Entity
Entity.getEntityColumns()
public java.util.Iterator getColumns(java.lang.String tableName)
getColumns
in interface Entity
Entity.getColumns(java.lang.String)
public java.util.Iterator getKeyColumns(java.lang.String tableName)
getKeyColumns
in interface Entity
Entity.getKeyColumns(java.lang.String)
public TableInfoBase getTypedReference()
public TableInfoBase getTypedReferenceForSet()
public boolean isTenantOwned()
public java.lang.String getCacheName()
getCacheName
in class CachedObjectPointer