Package com.ads.mm.db.dao
Class DBTable
java.lang.Object
com.ads.mm.db.dao.DBComponent
com.ads.mm.db.dao.DBTable
This class consists of methods relating to DBTable Object such as TableType, EntityBaseType, schemaName, tableDefinitionComments
tableDefinition, tableComments, logicalTableName, Audit History, userDefinedFields etc..
tableDefinition, tableComments, logicalTableName, Audit History, userDefinedFields etc..
- Author:
- AnalytiX DS
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThese constants are used to specify ENTITY, ENTITY_ROOT, ENTITY_ELEMENT, ENTITY_ATTRIBUTE.static enumThese Constants are used to specify the TableType as Table, View, Synonym or Component. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAssociationsList(com.ads.association.export.model.ExportedAssociation associationObj) It will not add association to this object as it is being used internally.voidAdds the column as specified.voidAdds the column specified with the details given as DBColumn.voidaddColumnByReferenceId(DBColumn column) Adds the Column as specified.addExtendedProperty(KeyValue systemKeyValuesVo) voidcopyColumns(DBTable table) Copies the columns as of like the columns as specified.booleanMethod used to compare for equality and returns value as true or false.booleanequals_old(Object obj) Method used to compare for equality and returns value as true or false.Returns the actualTableName.intList<com.ads.association.export.model.ExportedAssociation>It will not return any associations particular to this object as it is being used internally.Returns DBColumn Object for the specified name of the column.Returns the columnMap i.e it returns all the details pertaining to the column.Returns the createdBy.Returns the createdDateTime.intfloatReturns the dbOperation.Returns the dbOperationHelper.Returns the dbOperationHelper ObjectReturns the environment as specified.Returns the existence value.Returns the fileLocation.Returns the fileType.Returns the lastModifiedBy.Returns the lastModifiedDateTime.Returns the logicalTableName.Returns the referenceId.intgetSceid()Returns the sceId.Returns the schemaName.intintgetSTMId()Returns the stmId i.e tableId.Returns the tableAlias.Returns the tableClass.Returns the tableComments.Returns the tableDefinition.Returns the tableDefinitionComments.Returns the tableName,Returns the tableName without Schema.Returns the tableType.getTags()intReturns the usedInGapAnalysis.Returns the userData as specified.Returns the userDefined1 field.Returns the userDefined10 Field.Returns the userDefined2 field.Returns the userDefined3 field.Returns the userDefined4 field.Returns the userDefined5 field.Returns the userDefined6 Field.Returns the userDefined7 Field.Returns the userDefined8 Field.Returns the userDefined9 Field.inthashCode()hashCode is used to generate an integer code corresponding to the object.booleanhasOnly(DBTable.EntityBaseType baseType) Returns true if specified baseType is equal to the entityBaseType otherwise false.booleanbooleanReturns the value of rootTable i.e returns true if it the root otherwise returns false.booleanbooleanisValid()Returns the valid value.booleanstatic StringparseSchemaName(String tableName) parses the specified tableName and returns the schema name.voidsetActualTableName(String actualTableName) Sets the actualTableName as specified.voidsetAssociatedBusinessTerm(String associatedBusinessTerm) voidsetAssociatedBusinessTermId(int associatedBusinessTermId) setAssociationsList(List<com.ads.association.export.model.ExportedAssociation> associations) It will not set any associations particular to this object as it is being used internally.voidsetBusinessEntityType(String businessEntityType) setColumnIndexes(List<DBIndex> columnIndexes) voidsetColumnMap(Map<String, DBColumn> columnMap) Sets the columnMap as specified.voidsetCreatedBy(String createdBy) Sets the createdBy as specified.voidsetCreatedDateTime(Calendar createdDateTime) Sets the createdDateTime as specified.voidsetDataProfileScoreId(int dataProfileScoreId) voidsetDataQualityScore(float dataQualityScore) voidsetDBOperation(DBEnvironment.DBOperation dbOperation) Sets the dbOperation as specified.voidsetDbOperationHelper(DBOperationHelper dbOperationHelper) Sets the dbOperationHelper as specified.voidsetDBOperationHelper(DBOperationHelper dbOperationStatus) Sets the dbOperationHelper as specified.voidsetDeclarationPath(String declarationPath) voidsetDqToolProfileId(String dqToolProfileId) voidsetElnExpanded(boolean elnExpanded) voidsetEnvironment(DBEnvironment environment) Sets the environment as specified.voidsetExistence(String existence) Sets the existence as specified.voidsetExpandedLogicalName(String expandedLogicalName) setExtendedProperties(List<KeyValue> extendedProperties) voidsetFileLocation(String fileLocation) Sets the fileLocation as specified.voidsetFileType(String fileType) Sets the fileType as specified.voidsetLastModifiedBy(String lastModifiedBy) Sets the lastModifiedBy as specified.voidsetLastModifiedDateTime(Calendar lastModifiedDateTime) Sets the lastModifiedDateTime as specified.voidsetLogicalTableName(String logicalTableName) Sets the logicalTableName as specified.voidsetMetadataSource(String metadataSource) voidsetParentTable(DBTable _parentTable) Sets the parentTable as specified.voidsetPhysicalTableName(String physicalTableName) voidsetReferenceColumn(DBColumn referenceColumn) voidsetReferenceId(String referenceId) Sets the referenceId as specified.voidsetRootTable(boolean rootTable) Sets the rootTable as specified.voidsetSceid(int sceid) Sets the sceid as specified.voidsetSchemaName(String schemaName) Sets the schemaName as specified.voidsetSdiClassificationId(int sdiClassificationId) voidsetSdiClassifications(List<SDIClassification> sdiClassifications) voidsetSdiDescription(String sdiDescription) voidsetSdiFlag(boolean sdiFlag) voidsetSTMId(int stmId) Sets the stmId as specified.voidsetTableAlias(String tableAlias) Sets the tableAlias as specified.voidsetTableClass(String tableClass) Sets the tableClass as specified.voidsetTableComments(String tableComments) Sets the tableComments as specified.voidsetTableDefinition(String tableDefinition) Sets the tableDefinition as specified.voidsetTableDefinitionComments(String tableDefinitionComments) Sets the tableDefinitionComments as specified.voidsetTableName(String tableName) Sets the tableName as specified.voidsetTableType(DBTable.TableType tableType) Sets the tableType as specified.voidvoidsetTotalRowsCount(int totalRowsCount) voidsetUsedInGapAnalysis(String usedInGapAnalysis) Sets the usedInGapAnalysis as specified.voidsetUserData(Object userData) Sets the userData as specified.voidsetUserDefined1(String userDefined1) Sets the userDefined1 as specified.voidsetUserDefined10(String userDefined10) Sets the userDefined10 as specified.voidsetUserDefined2(String userDefined2) Sets the userDefined2 as specified.voidsetUserDefined3(String userDefined3) Sets the userDefined3 as specified.voidsetUserDefined4(String userDefined4) Sets the userDefined4 as specified.voidsetUserDefined5(String userDefined5) Sets the userDefined5 as specified.voidsetUserDefined6(String userDefined6) Sets the userDefined6 as specified.voidsetUserDefined7(String userDefined7) Sets the userDefined7 as specified.voidsetUserDefined8(String userDefined8) Sets the userDefined8 as specified.voidsetUserDefined9(String userDefined9) Sets the userDefined9 as specified.voidsetValid(boolean valid) Sets the valid as specified.voidsetValidateTransName(boolean validateTransName) toString()Returns the string representation.booleanvalidate()booleanMethods inherited from class com.ads.mm.db.dao.DBComponent
getDataStewardName, isMarked, setDataStewardName, setMarked
-
Constructor Details
-
DBTable
public DBTable() -
DBTable
-
-
Method Details
-
getParentTable
-
setParentTable
Sets the parentTable as specified.- Parameters:
_parentTable- DBTable
-
isValidateTransName
public boolean isValidateTransName() -
setValidateTransName
public void setValidateTransName(boolean validateTransName) -
getSceid
public int getSceid()Returns the sceId.- Returns:
- sceid - int
-
setSceid
public void setSceid(int sceid) Sets the sceid as specified.- Parameters:
sceid- int
-
getEnvironment
Returns the environment as specified.- Returns:
- environment DBEnvironment
-
setEnvironment
Sets the environment as specified.- Parameters:
environment- DBEnvironment
-
getSchemaName
Returns the schemaName.- Returns:
- schemaName - String
-
setSchemaName
Sets the schemaName as specified.- Parameters:
schemaName- String
-
getTableName
Returns the tableName,- Returns:
- tableName - String
-
getTableNameWithoutSchema
Returns the tableName without Schema.- Returns:
- tableName - String
-
setTableName
Sets the tableName as specified.- Parameters:
tableName- String
-
getTableDefinitionComments
Returns the tableDefinitionComments.- Returns:
- tableDefinitionComments - String
-
setTableDefinitionComments
Sets the tableDefinitionComments as specified.- Parameters:
tableDefinitionComments- String
-
getTableDefinition
Returns the tableDefinition.- Returns:
- tableDefinition - String
-
setTableDefinition
Sets the tableDefinition as specified.- Parameters:
tableDefinition- String
-
getTableComments
Returns the tableComments.- Returns:
- tableComments - String
-
setTableComments
Sets the tableComments as specified.- Parameters:
tableComments- String
-
getCreatedBy
Returns the createdBy.- Returns:
- createdBy - String
-
setCreatedBy
Sets the createdBy as specified.- Parameters:
createdBy- String
-
getCreatedDateTime
Returns the createdDateTime.- Returns:
- createdDateTime - Calendar
-
setCreatedDateTime
Sets the createdDateTime as specified.- Parameters:
createdDateTime- Calendar
-
getLastModifiedBy
Returns the lastModifiedBy.- Returns:
- lastModifiedBy - String
-
setLastModifiedBy
Sets the lastModifiedBy as specified.- Parameters:
lastModifiedBy- String
-
getLastModifiedDateTime
Returns the lastModifiedDateTime.- Returns:
- lastModifiedDateTime - Calendar
-
setLastModifiedDateTime
Sets the lastModifiedDateTime as specified.- Parameters:
lastModifiedDateTime- Calendar
-
getTableType
Returns the tableType.- Returns:
- tableType TableType
-
setTableType
Sets the tableType as specified.- Parameters:
tableType- TableType
-
getLogicalTableName
Returns the logicalTableName.- Returns:
- logicalTableName String
-
setLogicalTableName
Sets the logicalTableName as specified.- Parameters:
logicalTableName- String
-
isValid
public boolean isValid()Returns the valid value.- Returns:
- valid - boolean
-
setValid
public void setValid(boolean valid) Sets the valid as specified.- Parameters:
valid- boolean
-
getActualTableName
Returns the actualTableName.- Returns:
- actualTableName - String
-
setActualTableName
Sets the actualTableName as specified.- Parameters:
actualTableName- String
-
getColumnMap
Returns the columnMap i.e it returns all the details pertaining to the column.- Returns:
- columnMap - Map
-
setColumnMap
Sets the columnMap as specified.- Parameters:
columnMap- Map
-
getColumn
Returns DBColumn Object for the specified name of the column.- Parameters:
name- String- Returns:
- DBColumn Object
-
addColumn
Adds the column specified with the details given as DBColumn.- Parameters:
name- Stringcolumn- String
-
addColumn
Adds the column as specified.- Parameters:
column- String
-
addColumnByReferenceId
Adds the Column as specified.- Parameters:
column- String
-
getReferenceId
Returns the referenceId.- Returns:
- referenceId - String
-
setReferenceId
Sets the referenceId as specified.- Parameters:
referenceId- String
-
getDBOperationHelper
Returns the dbOperationHelper Object- Returns:
- dbOperationStatus - DBOperationHelper
-
setDBOperationHelper
Sets the dbOperationHelper as specified.- Parameters:
dbOperationStatus- DBOperationHelper
-
getUserData
Returns the userData as specified.- Returns:
- userData - Object
-
setUserData
Sets the userData as specified.- Parameters:
userData- Object
-
getUserDefined1
Returns the userDefined1 field.- Returns:
- userDefined1 - String
-
setUserDefined1
Sets the userDefined1 as specified.- Parameters:
userDefined1- String
-
getUserDefined2
Returns the userDefined2 field.- Returns:
- userDefined2 - String
-
setUserDefined2
Sets the userDefined2 as specified.- Parameters:
userDefined2- String
-
getUserDefined3
Returns the userDefined3 field.- Returns:
- userDefined3 - String
-
setUserDefined3
Sets the userDefined3 as specified.- Parameters:
userDefined3- String
-
getUserDefined4
Returns the userDefined4 field.- Returns:
- userDefined4 - String
-
setUserDefined4
Sets the userDefined4 as specified.- Parameters:
userDefined4- String
-
getUserDefined5
Returns the userDefined5 field.- Returns:
- userDefined5 - String
-
setUserDefined5
Sets the userDefined5 as specified.- Parameters:
userDefined5- String
-
getUsedInGapAnalysis
Returns the usedInGapAnalysis.- Returns:
- usedInGapAnalysis - String
-
getFileType
Returns the fileType.- Returns:
- fileType - String
-
setFileType
Sets the fileType as specified.- Parameters:
fileType- String
-
getFileLocation
Returns the fileLocation.- Returns:
- fileLocation - String
-
setFileLocation
Sets the fileLocation as specified.- Parameters:
fileLocation- String
-
getTotalRowsCount
public int getTotalRowsCount() -
setTotalRowsCount
public void setTotalRowsCount(int totalRowsCount) -
setUsedInGapAnalysis
Sets the usedInGapAnalysis as specified.- Parameters:
usedInGapAnalysis- String
-
copyColumns
Copies the columns as of like the columns as specified.- Parameters:
table- - DBTable- Throws:
CloneNotSupportedException
-
setDbOperationHelper
Sets the dbOperationHelper as specified.- Parameters:
dbOperationHelper- DBOperationHelper
-
setUserDefined10
Sets the userDefined10 as specified.- Parameters:
userDefined10- String
-
setUserDefined6
Sets the userDefined6 as specified.- Parameters:
userDefined6- String
-
setUserDefined7
Sets the userDefined7 as specified.- Parameters:
userDefined7- String
-
setUserDefined8
Sets the userDefined8 as specified.- Parameters:
userDefined8- String
-
setUserDefined9
Sets the userDefined9 as specified.- Parameters:
userDefined9- String
-
getDbOperationHelper
Returns the dbOperationHelper.- Returns:
- dbOperationHelper - DBOperationHelper
-
getUserDefined10
Returns the userDefined10 Field.- Returns:
- userDefined10 - String
-
getUserDefined6
Returns the userDefined6 Field.- Returns:
- userDefined6 - String
-
getUserDefined7
Returns the userDefined7 Field.- Returns:
- userDefined7 - String
-
getUserDefined8
Returns the userDefined8 Field.- Returns:
- userDefined8 - String
-
getUserDefined9
Returns the userDefined9 Field.- Returns:
- userDefined9 - String
-
getTableAlias
Returns the tableAlias.- Returns:
- tableAlias - String
-
setTableAlias
Sets the tableAlias as specified.- Parameters:
tableAlias- String
-
getTableClass
Returns the tableClass.- Returns:
- tableClass - String
-
setTableClass
Sets the tableClass as specified.- Parameters:
tableClass- String
-
isSdiFlag
public boolean isSdiFlag()- Returns:
- the sdiFlag
-
setSdiFlag
public void setSdiFlag(boolean sdiFlag) - Parameters:
sdiFlag- the sdiFlag to set
-
getSdiDescription
- Returns:
- the sdiDescription
-
setSdiDescription
- Parameters:
sdiDescription- the sdiDescription to set
-
getSdiClassificationId
public int getSdiClassificationId()- Returns:
- the sdiClassificationId
-
setSdiClassificationId
public void setSdiClassificationId(int sdiClassificationId) - Parameters:
sdiClassificationId- the sdiClassificationId to set
-
getExistence
Returns the existence value.- Returns:
- existence - String
-
setExistence
Sets the existence as specified.- Parameters:
existence- String
-
getDBOperation
Returns the dbOperation. dbOperation can be UPDATE, INSERT, VALIDATE, INVALIDATE or SKIP.- Returns:
- dbOperation - DBOperation
-
setDBOperation
Sets the dbOperation as specified.- Parameters:
dbOperation- DBOperation
-
getSTMId
public int getSTMId()Returns the stmId i.e tableId.- Returns:
- stmId - int
-
setSTMId
public void setSTMId(int stmId) Sets the stmId as specified.- Parameters:
stmId- int
-
parseSchemaName
parses the specified tableName and returns the schema name.- Parameters:
tableName- String- Returns:
- schemaName - String
-
toString
Returns the string representation. -
equals
Method used to compare for equality and returns value as true or false. -
equals_old
Method used to compare for equality and returns value as true or false.- Parameters:
obj- Object- Returns:
- boolean - True or False.
-
hashCode
public int hashCode()hashCode is used to generate an integer code corresponding to the object. -
isRootTable
public boolean isRootTable()Returns the value of rootTable i.e returns true if it the root otherwise returns false.- Returns:
- rootTable - boolean
-
setRootTable
public void setRootTable(boolean rootTable) Sets the rootTable as specified.- Parameters:
rootTable- boolean
-
hasOnly
Returns true if specified baseType is equal to the entityBaseType otherwise false.- Parameters:
baseType- DBTable Object- Returns:
- - boolean
-
getMetadataSource
- Returns:
-
setMetadataSource
- Parameters:
metadataSource-
-
getExtendedProperties
-
setExtendedProperties
-
addExtendedProperty
-
getTags
-
setTags
-
addTag
-
getAssociationsList
It will not return any associations particular to this object as it is being used internally. Please use Associations api to fetch the associations.- Returns:
- list of associations
-
setAssociationsList
public DBTable setAssociationsList(List<com.ads.association.export.model.ExportedAssociation> associations) It will not set any associations particular to this object as it is being used internally.- Parameters:
associations-- Returns:
-
addAssociationsList
public DBTable addAssociationsList(com.ads.association.export.model.ExportedAssociation associationObj) It will not add association to this object as it is being used internally.- Parameters:
associations-- Returns:
-
getDqToolProfileId
-
setDqToolProfileId
-
getDataQualityScore
public float getDataQualityScore() -
setDataQualityScore
public void setDataQualityScore(float dataQualityScore) -
getColumnIndexes
- Returns:
-
setColumnIndexes
-
getExpandedLogicalName
- Returns:
-
setExpandedLogicalName
- Parameters:
expandedLogicalName-
-
getAssociatedBusinessTerm
- Returns:
-
setAssociatedBusinessTerm
- Parameters:
associatedBusinessTerm-
-
getAssociatedBusinessTermId
public int getAssociatedBusinessTermId()- Returns:
-
setAssociatedBusinessTermId
public void setAssociatedBusinessTermId(int associatedBusinessTermId) - Parameters:
associatedBusinessTermId-
-
isElnExpanded
public boolean isElnExpanded()- Returns:
-
setElnExpanded
public void setElnExpanded(boolean elnExpanded) - Parameters:
elnExpanded-
-
getDeclarationPath
- Returns:
- the declarationPath
-
setDeclarationPath
- Parameters:
declarationPath- the declarationPath to set
-
getBusinessEntityType
-
setBusinessEntityType
-
getDataProfileScoreId
public int getDataProfileScoreId()- Returns:
- dataProfileScoreId
-
setDataProfileScoreId
public void setDataProfileScoreId(int dataProfileScoreId) - Parameters:
dataProfileScoreId- the dataProfileScoreId to set
-
getPhysicalTableName
- Returns:
- the physicalTableName
-
setPhysicalTableName
- Parameters:
physicalTableName- the physicalTableName to set
-
getSdiClassifications
-
setSdiClassifications
-
validate
public boolean validate() -
validateMandatoryFields
public boolean validateMandatoryFields() -
getReferenceColumn
- Returns:
- the referenceColumn
-
setReferenceColumn
- Parameters:
referenceColumn- the referenceColumn to set
-