public interface Table extends Exportable, OptionContainer, RelationalObject, SchemaElement
Modifier and Type | Interface and Description |
---|---|
static class |
Table.OnCommit
The on commit value.
|
static class |
Table.TemporaryType
Temporary table types.
|
RelationalObject.Filter
SchemaElement.SchemaElementType
Modifier and Type | Field and Description |
---|---|
static long |
DEFAULT_CARDINALITY
The default value of this table's cardinality.
|
static boolean |
DEFAULT_MATERIALIZED
The default value indicating if this table is materialized.
|
static boolean |
DEFAULT_UPDATABLE
The default value indicating if this table is updatable.
|
static KomodoType |
IDENTIFIER
Identifier of this object
|
static Table[] |
NO_TABLES
An empty array of tables.
|
static TypeResolver<Table> |
RESOLVER
The resolver of a
Table . |
static int |
TYPE_ID
The type identifier.
|
DDL_QNAMES_FILTER, DEFAULT_FILTERS, JCR_FILTER, NO_FILTERS, NT_FILTER, RESIDUAL_FILTER
EMPTY_ARRAY
export, getDocumentType, getName
getCustomOptions, getStandardOptions, getStatementOptionNames, getStatementOptions, isCustomOption, isStandardOption, removeStatementOption, setStatementOption
getFilters, setFilters
accept, addChild, addDescriptor, getChild, getChild, getChildren, getChildrenOfType, getChildTypes, getDescriptor, getDescriptors, getIndex, getObjectFactory, getPrimaryType, getProperty, getPropertyDescriptor, getPropertyDescriptors, getPropertyFactory, getPropertyNames, getRawChildren, getRawDescriptors, getRawParent, getRawProperty, getRawPropertyDescriptors, getRawPropertyNames, getTypeId, getTypeIdentifier, hasChild, hasChild, hasChildren, hasDescriptor, hasProperties, hasProperty, hasRawChild, hasRawChild, hasRawChildren, hasRawProperty, isChildRestricted, print, remove, removeChild, removeDescriptor, rename, setPrimaryType, setProperty
getAbsolutePath, getName, getRepository
getSchemaElementType, setSchemaElementType
static final int TYPE_ID
static final KomodoType IDENTIFIER
static final long DEFAULT_CARDINALITY
static final boolean DEFAULT_MATERIALIZED
static final boolean DEFAULT_UPDATABLE
static final Table[] NO_TABLES
static final TypeResolver<Table> RESOLVER
Table
.Model getParent(Repository.UnitOfWork transaction) throws KException
getParent
in interface KNode
KException
KNode.getParent(org.komodo.spi.repository.Repository.UnitOfWork)
AccessPattern addAccessPattern(Repository.UnitOfWork transaction, String accessPatternName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)accessPatternName
- the name of the access pattern being added (cannot be empty)null
)KException
- if an error occursColumn addColumn(Repository.UnitOfWork transaction, String columnName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)columnName
- the name of the column being added (cannot be empty)null
)KException
- if an error occursForeignKey addForeignKey(Repository.UnitOfWork transaction, String foreignKeyName, Table referencedTable) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)foreignKeyName
- the name of the foreign key being added (cannot be empty)referencedTable
- the table referenced by this foreign key (cannot be null
)null
)KException
- if an error occursIndex addIndex(Repository.UnitOfWork transaction, String indexName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)indexName
- the name of the index being added (cannot be empty)null
)KException
- if an error occursUniqueConstraint addUniqueConstraint(Repository.UnitOfWork transaction, String constraintName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)constraintName
- the name of the unique constraint being added (cannot be empty)null
)KException
- if an error occursAccessPattern[] getAccessPatterns(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occurslong getCardinality(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursDEFAULT_CARDINALITY
Column[] getColumns(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursString getDescription(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)description
property (can be empty)KException
- if an error occursForeignKey[] getForeignKeys(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursIndex[] getIndexes(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursString getMaterializedTable(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursString getNameInSource(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)name in source
property (can be empty)KException
- if an error occursTable.OnCommit getOnCommitValue(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
)KException
- if an error occursPrimaryKey getPrimaryKey(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
)KException
- if an error occursString getQueryExpression(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursTable.TemporaryType getTemporaryTableType(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
if not a temporary tableKException
- if an error occursUniqueConstraint[] getUniqueConstraints(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursString getUuid(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)UUID
option (can be empty)KException
- if an error occursboolean isMaterialized(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if this is a materialized tableKException
- if an error occursDEFAULT_MATERIALIZED
boolean isUpdatable(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if this table is updatableKException
- if an error occursDEFAULT_UPDATABLE
void removeAccessPattern(Repository.UnitOfWork transaction, String accessPatternToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)accessPatternToRemove
- the name of the access pattern being removed (cannot be empty)KException
- if an error occursvoid removeColumn(Repository.UnitOfWork transaction, String columnToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)columnToRemove
- the name of the column being removed (cannot be empty)KException
- if an error occursvoid removeForeignKey(Repository.UnitOfWork transaction, String foreignKeyToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)foreignKeyToRemove
- the name of the foreign key being removed (cannot be empty)KException
- if an error occursvoid removeIndex(Repository.UnitOfWork transaction, String indexToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)indexToRemove
- the name of the index being removed (cannot be empty)KException
- if an error occursvoid removePrimaryKey(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursvoid removeUniqueConstraint(Repository.UnitOfWork transaction, String constraintToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)constraintToRemove
- the name of the unique constraint being removed (cannot be empty)KException
- if an error occursvoid setCardinality(Repository.UnitOfWork transaction, long newCardinality) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newCardinality
- the new value for the cardinality
propertyKException
- if an error occursDEFAULT_CARDINALITY
void setDescription(Repository.UnitOfWork transaction, String newDescription) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newDescription
- the new value of the description
property (can only be empty when removing)KException
- if an error occursvoid setMaterialized(Repository.UnitOfWork transaction, boolean newMaterialized) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newMaterialized
- the new value for the materialized
propertyKException
- if an error occursDEFAULT_MATERIALIZED
void setMaterializedTable(Repository.UnitOfWork transaction, String newMaterializedTable) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newMaterializedTable
- the new value for the materialized table
property (can only be empty when removing)KException
- if an error occursvoid setNameInSource(Repository.UnitOfWork transaction, String newNameInSource) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newNameInSource
- the new name in source (can only be empty when removing)KException
- if an error occursvoid setOnCommitValue(Repository.UnitOfWork transaction, Table.OnCommit newOnCommit) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newOnCommit
- the new value for the on commit value
property (can be null
)KException
- if an error occursPrimaryKey setPrimaryKey(Repository.UnitOfWork transaction, String newPrimaryKeyName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newPrimaryKeyName
- the name of the new primary key
child (cannot be empty)null
)KException
- if an error occursvoid setQueryExpression(Repository.UnitOfWork transaction, String newQueryExpression) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newQueryExpression
- the new value for the query expression
property (can be empty)KException
- if an error occursvoid setTemporaryTableType(Repository.UnitOfWork transaction, Table.TemporaryType newTempType) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newTempType
- the new value for the temporary table type
property (can be null
)KException
- if an error occursvoid setUpdatable(Repository.UnitOfWork transaction, boolean newUpdatable) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newUpdatable
- the new value for the updatable
propertyKException
- if an error occursDEFAULT_UPDATABLE
void setUuid(Repository.UnitOfWork transaction, String newUuid) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newUuid
- the new value of the UUID
option (can only be empty when removing)KException
- if an error occursCopyright © 2013–2019. All rights reserved.