public interface Column extends OptionContainer, RelationalObject
Modifier and Type | Interface and Description |
---|---|
static class |
Column.Searchable
The values for a column's searchable property.
|
RelationalObject.Filter
Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_AUTO_INCREMENTED
The default value for the
auto-incremented property. |
static boolean |
DEFAULT_CASE_SENSITIVE
The default value for the
case-sensitive property. |
static long |
DEFAULT_CHAR_OCTET_LENGTH
The default value for the
character octet length property. |
static boolean |
DEFAULT_CURRENCY
The default value for the
currency property. |
static long |
DEFAULT_DISTINCT_VALUES
The default value for the
distinct values property. |
static boolean |
DEFAULT_FIXED_LENGTH
The default value for the
fixed length property. |
static long |
DEFAULT_NULL_VALUE_COUNT
The default value for the
null value count property. |
static long |
DEFAULT_RADIX
The default value for the
datatype radix property. |
static boolean |
DEFAULT_SELECTABLE
The default value indicating if this column is selectable.
|
static boolean |
DEFAULT_SIGNED
The default value for the
signed property. |
static boolean |
DEFAULT_UPDATABLE
The default value indicating if this column is updatable.
|
static KomodoType |
IDENTIFIER
Identifier of this object
|
static Column[] |
NO_COLUMNS
An empty array of columns.
|
static TypeResolver<Column> |
RESOLVER
The resolver of a
Column . |
static int |
TYPE_ID
The type identifier.
|
DDL_QNAMES_FILTER, DEFAULT_FILTERS, JCR_FILTER, NO_FILTERS, NT_FILTER, RESIDUAL_FILTER
EMPTY_ARRAY
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
static final int TYPE_ID
static final KomodoType IDENTIFIER
static final boolean DEFAULT_AUTO_INCREMENTED
auto-incremented
property. Value is false .static final boolean DEFAULT_CASE_SENSITIVE
case-sensitive
property. Value is false .static final long DEFAULT_CHAR_OCTET_LENGTH
character octet length
property. Value is 0L .static final boolean DEFAULT_CURRENCY
currency
property. Value is false .static final long DEFAULT_DISTINCT_VALUES
distinct values
property. Value is -1L .static final boolean DEFAULT_FIXED_LENGTH
fixed length
property. Value is false .static final long DEFAULT_NULL_VALUE_COUNT
null value count
property. Value is -1L .static final long DEFAULT_RADIX
datatype radix
property. Value is 0L .static final boolean DEFAULT_SELECTABLE
static final boolean DEFAULT_SIGNED
signed
property. Value is false .static final boolean DEFAULT_UPDATABLE
static final Column[] NO_COLUMNS
static final TypeResolver<Column> RESOLVER
Column
.Table getParent(Repository.UnitOfWork transaction) throws KException
getParent
in interface KNode
KException
KNode.getParent(org.komodo.spi.repository.Repository.UnitOfWork)
long getCharOctetLength(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)char octet length
propertyKException
- if an error occursString getCollationName(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)collation name
property (can be empty)KException
- if an error occursString getDatatypeName(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)datatype name
property (can be empty)KException
- if an error occursRelationalConstants.DEFAULT_DATATYPE_NAME
String getDefaultValue(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)default value
property (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 occurslong getDistinctValues(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_DISTINCT_VALUES
long getLength(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)datatype length
propertyKException
- if an error occursRelationalConstants.DEFAULT_LENGTH
String getMaxValue(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)maximum value
property (can be empty)KException
- if an error occursString getMinValue(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)minimum value
property (can be empty)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 occursString getNativeType(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)native type
property (can be empty)KException
- if an error occursRelationalConstants.Nullable getNullable(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)nullable
property (never null
)KException
- if an error occursRelationalConstants.Nullable.DEFAULT_VALUE
long getNullValueCount(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null value count
propertyKException
- if an error occurslong getPrecision(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)datatype precision
propertyKException
- if an error occursRelationalConstants.DEFAULT_PRECISION
long getRadix(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)datatype radix
propertyKException
- if an error occurslong getScale(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)datatype scale
propertyKException
- if an error occursRelationalConstants.DEFAULT_SCALE
Column.Searchable getSearchable(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)searchable
property (never null
)KException
- if an error occursColumn.Searchable.DEFAULT_VALUE
String 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 isAutoIncremented(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 auto-incrementedKException
- if an error occursDEFAULT_AUTO_INCREMENTED
boolean isCaseSensitive(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 case-sensitiveKException
- if an error occursDEFAULT_CASE_SENSITIVE
boolean isCurrency(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 column holds a currency valueKException
- if an error occursDEFAULT_CURRENCY
boolean isFixedLength(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 column has a fixed lengthKException
- if an error occursDEFAULT_FIXED_LENGTH
boolean isSelectable(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 column is selectableKException
- if an error occursDEFAULT_SELECTABLE
boolean isSigned(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 column's value is signedKException
- if an error occursDEFAULT_SIGNED
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 column is updatableKException
- if an error occursDEFAULT_UPDATABLE
void setAutoIncremented(Repository.UnitOfWork transaction, boolean newAutoIncremented) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newAutoIncremented
- the new value for the auto-incremented
propertyKException
- if an error occursDEFAULT_AUTO_INCREMENTED
void setCaseSensitive(Repository.UnitOfWork transaction, boolean newCaseSensitive) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newCaseSensitive
- the new value for the case-sensitive
propertyKException
- if an error occursDEFAULT_CASE_SENSITIVE
void setCharOctetLength(Repository.UnitOfWork transaction, long newCharOctetLength) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newCharOctetLength
- the new value of the char octet length
propertyKException
- if an error occursvoid setCollationName(Repository.UnitOfWork transaction, String newCollationName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newCollationName
- the new value of the collation name
property (can be empty)KException
- if an error occursvoid setCurrency(Repository.UnitOfWork transaction, boolean newCurrency) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newCurrency
- the new value for the currency
propertyKException
- if an error occursDEFAULT_CURRENCY
void setDatatypeName(Repository.UnitOfWork transaction, String newTypeName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newTypeName
- the new value of the datatype name
propertyKException
- if an error occursRelationalConstants.DEFAULT_DATATYPE_NAME
void setDefaultValue(Repository.UnitOfWork transaction, String newDefaultValue) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newDefaultValue
- the new value of the default value
property (can be empty)KException
- if an error occursvoid 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 setDistinctValues(Repository.UnitOfWork transaction, long newDistinctValues) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newDistinctValues
- the new value for the distinct values
propertyKException
- if an error occursDEFAULT_DISTINCT_VALUES
void setFixedLength(Repository.UnitOfWork transaction, boolean newFixedLength) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newFixedLength
- the new value for the fixed length
propertyKException
- if an error occursDEFAULT_FIXED_LENGTH
void setLength(Repository.UnitOfWork transaction, long newLength) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newLength
- the new value of the datatype length
propertyKException
- if an error occursRelationalConstants.DEFAULT_LENGTH
void setMaxValue(Repository.UnitOfWork transaction, String newMaxValue) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newMaxValue
- the new maximum value (can only be empty when removing)KException
- if an error occursvoid setMinValue(Repository.UnitOfWork transaction, String newMinValue) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newMinValue
- the new minimum value (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 setNativeType(Repository.UnitOfWork transaction, String newNativeType) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newNativeType
- the new value of the native type
property (can only be empty when removing)KException
- if an error occursvoid setNullable(Repository.UnitOfWork transaction, RelationalConstants.Nullable newNullable) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newNullable
- the new value of the nullable
property (can be null
)KException
- if an error occursRelationalConstants.Nullable.DEFAULT_VALUE
void setNullValueCount(Repository.UnitOfWork transaction, long newNullValueCount) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newNullValueCount
- the new value of the null value count
propertyKException
- if an error occursvoid setPrecision(Repository.UnitOfWork transaction, long newPrecision) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newPrecision
- the new value of the datatype precision
propertyKException
- if an error occursRelationalConstants.DEFAULT_PRECISION
void setRadix(Repository.UnitOfWork transaction, long newRadix) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newRadix
- the new value of the datatype radix
propertyKException
- if an error occursvoid setScale(Repository.UnitOfWork transaction, long newScale) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newScale
- the new value of the datatype scale
propertyKException
- if an error occursRelationalConstants.DEFAULT_SCALE
void setSearchable(Repository.UnitOfWork transaction, Column.Searchable newSearchable) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newSearchable
- the new value of the searchable
property (can be null
)KException
- if an error occursColumn.Searchable.DEFAULT_VALUE
void setSelectable(Repository.UnitOfWork transaction, boolean newSelectable) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newSelectable
- the new value for the selectable
propertyKException
- if an error occursDEFAULT_SELECTABLE
void setSigned(Repository.UnitOfWork transaction, boolean newSigned) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newSigned
- the new value for the signed
propertyKException
- if an error occursDEFAULT_SIGNED
void 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.