oracle.odi.mapping.generation

Class Table

java.lang.Object

oracle.odi.mapping.generation.AbstractSyntaxTree

oracle.odi.mapping.generation.Table

public class Table
extends AbstractSyntaxTree

A class to represent a source table in a SQL query.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree

AbstractSyntaxTree.LogCounter

Method Summary

Modifier and Type	Method and Description
IDataStore	getBoundDatastore()
java.util.List	getChildren() Get the list of child objects owned by this substitution API object.
java.lang.String	getCreationName() The creation name is used when a DDL statement is generated to create the database table.
java.lang.String	getCreationText()
java.lang.String	getCustomText()
IMapComponent	getDatastoreComponent() Get the reference Datastore component.
java.util.List	getExpressions() Get a list of expressions owned by this substitution API object.
FromClause	getFromClause() Get the from clause of this table.
java.lang.String	getFullGeneratedName()
java.lang.String	getGeneratedName()
java.lang.String	getGeneratedName(boolean includePartition) Get the generated table name for this table.
java.lang.String	getGeneratedName(boolean includePartition, java.lang.String suffix) Get the full generated table name for this table.
java.lang.String	getGeneratedName(java.lang.String suffix) Get the generated table name for this table, with an extra suffix appended.
IModelObject	getModelTable() Get the reference model object.
java.lang.String	getName()
java.lang.String	getQualifier()
java.lang.String	getTableProperty(java.lang.String name) Get the value of the named substitution API object property.
java.util.Map	getTemplateSubstitutionMap() Get a hash map containing built-in template substitution variable names as the hash key, and the substitution variable value as values.
java.lang.String	getType() Get a class type string for this substitution API object.

Methods inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree

getCodeGenerationTemplate, getCodeGenerationTemplateName, getCustomTemplate, getKMName, getLeafLevelChildren, getMapPhysicalNode, getOrder, getParentAST, getParentOfType, getPropertyValue, getSourceLanguage, getSourceLocation, getSourceTechnology, getSourceText, getTargetLanguage, getTargetLocation, getTargetTechnology, getTargetText, getText, hasCustomTemplate, hasSourceAndTargetText, isLeafLevelNode, isPushFromSource

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns:

The name of this table.

getQualifier

public java.lang.String getQualifier()

Returns:

The logical schema name of this table.

getCustomText

public java.lang.String getCustomText()

Returns:

The custom text for this table, if any, else null.

getCreationText

public java.lang.String getCreationText()

Returns:

the creation text for this table. If not null, this is text that will be used as the full table name when creating the table, and may include partition information for the table.

getGeneratedName

public java.lang.String getGeneratedName()

Returns:

The generated table name of this table.

getGeneratedName

public java.lang.String getGeneratedName(java.lang.String suffix)

Get the generated table name for this table, with an extra suffix appended.

Parameters:

suffix - The suffix to append to the original name.

Returns:

The generated name.

getFullGeneratedName

public java.lang.String getFullGeneratedName()

Returns:

The full generated table name of this table.

getCreationName

public java.lang.String getCreationName()

The creation name is used when a DDL statement is generated to create the database table.

Returns:

The creation name for this table.

getGeneratedName

public java.lang.String getGeneratedName(boolean includePartition)

Get the generated table name for this table.

Parameters:

includePartition - If generated name includes partition information.

Returns:

The generated table name for this table.

getGeneratedName

public java.lang.String getGeneratedName(boolean includePartition,
                                         java.lang.String suffix)

Get the full generated table name for this table. The full generated table name is the name which includes partition information.

Parameters:

includePartition - If generated name includes partition information.

suffix - The suffix to append to the original name.

Returns:

The generated table name.

getTableProperty

public java.lang.String getTableProperty(java.lang.String name)

Get the value of the named substitution API object property.

Parameters:

name - The name of this property.

Returns:

The value of this property.

getModelTable

public IModelObject getModelTable()

Get the reference model object.

Returns:

The reference object.

getDatastoreComponent

public IMapComponent getDatastoreComponent()

Get the reference Datastore component.

Returns:

The reference datastore component, if any, otherwise null.

getBoundDatastore

public IDataStore getBoundDatastore()
                             throws MappingException,
                                    AdapterException

Returns:

The bound datastore of this table.

Throws:

MappingException

AdapterException

getType

public java.lang.String getType()

Description copied from class: AbstractSyntaxTree

Get a class type string for this substitution API object.

Specified by:

getType in class AbstractSyntaxTree

Returns:

A simple class type name for this object.

getChildren

public java.util.List getChildren()

Description copied from class: AbstractSyntaxTree

Get the list of child objects owned by this substitution API object.

Specified by:

getChildren in class AbstractSyntaxTree

Returns:

The list of child objects.

getTemplateSubstitutionMap

public java.util.Map getTemplateSubstitutionMap()

Description copied from class: AbstractSyntaxTree

Get a hash map containing built-in template substitution variable names as the hash key, and the substitution variable value as values.

Specified by:

getTemplateSubstitutionMap in class AbstractSyntaxTree

Returns:

The built-in template substitution hash map.

getExpressions

public java.util.List getExpressions()

Description copied from class: AbstractSyntaxTree

Get a list of expressions owned by this substitution API object.

Specified by:

getExpressions in class AbstractSyntaxTree

Returns:

The list of expressions.

getFromClause

public FromClause getFromClause()

Get the from clause of this table. Return null if this table doesn't have a parent FromClause object.

Returns:

The from clause of this table.