psdi.mbo

Class TableInfoBase

java.lang.Object

psdi.util.CachedObject

psdi.mbo.TableInfoBase

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TableInfoBase
extends CachedObject

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
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() Return the identifier of the repository name for this cached object
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.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.lang.String	getExtTableName() Returns the name of the extension table.
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()
java.lang.String	getUniqueColumnName() Get the unqiue column name of this table.
boolean	hasImplicitTenantId()
boolean	hasImplicitTenantId(java.lang.String tableName)
boolean	hasRowStamp() Returns whether rowstamp information exists for this table or not.
boolean	isRowStampColumnExists() Returns whether rowstamp column exists for this table or not.
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	setAltIxName(java.lang.String name) Set the alternate index name of the table.
void	setContentAttrName(java.lang.String name) Set the content attribute name for the table.
void	setEAuditTableName(java.lang.String auditTableName) Sets the audit table name in which the audit record information is written.
void	setExtTableName(java.lang.String extTableName) Sets the name of the extension table.
void	setLangColumnName(java.lang.String langColName) Sets the Unique Column name for which sequence is created
void	setLangTBName(java.lang.String tbname) Sets this table's language table.
void	setRowStampColumnExists(boolean rowStampColumnExists) Sets whether rowstamp column exists for this table or not.
void	setTableName(java.lang.String tableName) Sets the name of the table.
void	setTextSearchEnabled(boolean textSearchEnabled) sets whether this table is text search enabled or not
void	setUniqueColumnName(java.lang.String name) Set the unique column name of the table.
void	setUsedForAuditing(boolean usedForAuditing) Sets whether this table is used for auditing or not.
void	setUsedForMLang(boolean usedForML) Set the flag to indicate if this table is the language table or not.

Methods inherited from class psdi.util.CachedObject

addToRepository, getClonedInfo, getID, getReference, getTenantId, isLoaded, isMasterInfo, isSameTenantAsReference, setID, setReference, setTenantId, setTenantReference

Methods inherited from class java.lang.Object

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

Method Detail

getEAuditTableName

public java.lang.String getEAuditTableName()

Returns the audit table name in which the audit record information is written.

Returns:

audit table name.

setEAuditTableName

public void setEAuditTableName(java.lang.String auditTableName)

Sets the audit table name in which the audit record information is written.

Parameters:

string - audit table name.

isUsedForAuditing

public boolean isUsedForAuditing()

Returns whether this table is used for auditing.

Returns:

true, if this table is used for auditing, otherwise false.

setUsedForAuditing

public void setUsedForAuditing(boolean usedForAuditing)

Sets whether this table is used for auditing or not.

Parameters:

usedForAuditing - pass true, if this table is used for auditing, otherwise false.

isUsedForMLang

public boolean isUsedForMLang()

Return whether the table is the language table for multi-lang support

Returns:

setUsedForMLang

public void setUsedForMLang(boolean usedForML)

Set the flag to indicate if this table is the language table or not.

Parameters:

usedForML - true if the table is language table.

isRowStampColumnExists

public boolean isRowStampColumnExists()

Returns whether rowstamp column exists for this table or not.

Returns:

true, if rowstamp column exists for this table, otherwise false.

setRowStampColumnExists

public void setRowStampColumnExists(boolean rowStampColumnExists)

Sets whether rowstamp column exists for this table or not.

Parameters:

rowStampColumnExists - pass true, if rowstamp column exists for this table, otherwise false.

getTableName

public java.lang.String getTableName()

Returns the name of the table.

Returns:

the name of the table.

setTableName

public void setTableName(java.lang.String tableName)

Sets the name of the table.

Parameters:

tableName - name of the table.

getExtTableName

public java.lang.String getExtTableName()

Returns the name of the extension table.

Returns:

the name of the extension table.

setExtTableName

public void setExtTableName(java.lang.String extTableName)

Sets the name of the extension table.

Parameters:

tableName - name of the extension table.

setTextSearchEnabled

public void setTextSearchEnabled(boolean textSearchEnabled)

sets whether this table is text search enabled or not

Parameters:

textSearchEnabled -

isTextSearchEnabled

public boolean isTextSearchEnabled()

returns whether this table is text search enabled or not

Returns:

true if table is text search enabled else false.

getTables

public java.util.Iterator getTables()

Returns an Iterator to iterate over table name. The iterator objects are of type String. This iterator always has only one object to iterate. This method is provided to support the Entity interface.

Returns:

an Iterator to iterate over table name.

See Also:

Entity.getTables()

getTableCount

public int getTableCount()

Returns the number of tables associated with this object. This method is provided to support the Entity interface. Always returns 1.

Returns:

the number of tables, always returns 1.

See Also:

Entity.getTableCount()

getTablesInHierarchyOrder

public java.util.Iterator getTablesInHierarchyOrder()

Returns an Iterator to iterate over table name. The iterator objects are of type String. This iterator always has only one object to iterate. This method is provided to support the Entity interface.

Returns:

an Iterator to iterate over table name.

See Also:

Entity.getTablesInHierarchyOrder()

getTablesInReverseHierarchyOrder

public java.util.Iterator getTablesInReverseHierarchyOrder()

Returns an Iterator to iterate over table name in reverse hierarchy order. The iterator objects are of type String. This iterator always has only one object to iterate. This method is provided to support the Entity interface.

Returns:

an Iterator to iterate over table name.

See Also:

Entity.getTablesInReverseHierarchyOrder()

getTableName

public java.lang.String getTableName(java.lang.String entityColumnName)

Returns the table name for the given column name. Always returns the name of this table. This method is provided to support the Entity interface.

Parameters:

entityColumnName - column name

Returns:

table name

See Also:

Entity.getTableName(java.lang.String)

getColumnName

public java.lang.String getColumnName(java.lang.String entityColumnName)

Returns the column name for the given entity column name. Always returns the entity column name passed. This method is provided to support the Entity interface.

Parameters:

entityColumnName - column name

Returns:

column name

See Also:

Entity.getColumnName(java.lang.String)

getColumnName

public 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. Always returns the entity column name passed. This method is provided to support the Entity interface.

Parameters:

entityColumnName - entity column name

tableName - table name

Returns:

column name

See Also:

Entity.getColumnName(java.lang.String, java.lang.String)

getEntityColumnName

public 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. Always returns the table column name passed. This method is provided to support the Entity interface.

Parameters:

tableColumnName - table column name

tableName - table name

Returns:

entity column name

See Also:

Entity.getEntityColumnName(java.lang.String, java.lang.String)

getRowStampInfo

public RowStampInfo getRowStampInfo()

Returns rowstamp information for this table, if rowstamp column exists. This method is provided to support the Entity interface.

Returns:

rowstamp information in RowStampInfo object, if rowstamp column exists, otherwise returns null.

See Also:

Entity.getRowStampInfo()

getTenantIdInfo

public TenantIdInfo getTenantIdInfo()

hasRowStamp

public boolean hasRowStamp()

Returns whether rowstamp information exists for this table or not. This method is provided to support the Entity interface.

Returns:

true, if rowstamp information exists, otherwise false.

See Also:

Entity.hasRowStamp()

getAuditTable

public java.lang.String getAuditTable(java.lang.String tableName)

Returns audit table associated with this table, if any.

Returns:

audit table associated with this table, if any, otherwise returns null.

See Also:

Entity.getAuditTable(java.lang.String)

getLangTBName

public java.lang.String getLangTBName()

Get the language table name of this table. If there is no language table associated with this table either the multi-lang support is never being used or not enabled at all, this method will return null.

Returns:

setLangTBName

public void setLangTBName(java.lang.String tbname)

Sets this table's language table.

Parameters:

tbname -

getUniqueColumnName

public java.lang.String getUniqueColumnName()

Get the unqiue column name of this table.

Returns:

the unique column name.

setUniqueColumnName

public void setUniqueColumnName(java.lang.String name)

Set the unique column name of the table.

Parameters:

The - unique column name

getContentAttrName

public java.lang.String getContentAttrName()

Get the content attribute name for this table.

Returns:

the content attribute name.

setContentAttrName

public void setContentAttrName(java.lang.String name)

Set the content attribute name for the table.

Parameters:

The - content attribute name

getAltIxName

public java.lang.String getAltIxName()

Get the alternate index name of this table.

Returns:

The alternate index name.

setAltIxName

public void setAltIxName(java.lang.String name)

Set the alternate index name of the table.

Parameters:

The - alternate index name

getLangColumnName

public java.lang.String getLangColumnName()

Returns the Unique Column name for which sequence is created

Returns:

Unique Column name.

getLangColumnName

public java.lang.String getLangColumnName(java.lang.String tableName)

Returns the Language Column name This method is provided to support the Entity interface.

Returns:

langauge Column name.

setLangColumnName

public void setLangColumnName(java.lang.String langColName)

Sets the Unique Column name for which sequence is created

Parameters:

string - Unique Column name

getStorageType

public int getStorageType()

Returns:

the storage type for the table.

getMLParent

public java.lang.String getMLParent()

Returns:

the parent table for the multi langauge table

hasImplicitTenantId

public boolean hasImplicitTenantId(java.lang.String tableName)

hasImplicitTenantId

public boolean hasImplicitTenantId()

getCacheName

public java.lang.String getCacheName()

Description copied from class: CachedObject

Return the identifier of the repository name for this cached object

Specified by:

getCacheName in class CachedObject

Returns: