org.teiid.connector.metadata.runtime
Interface Element

All Superinterfaces:

MetadataObject, TypeModel

public interface Element
extends MetadataObject, TypeModel

Represents an element, such as a column, in runtime metadata.

Field Summary

Fields inherited from interface org.teiid.connector.metadata.runtime.TypeModel

NOT_NULLABLE, NOT_SEARCHABLE, NULLABLE, NULLABLE_UNKNOWN, SEARCHABLE, SEARCHABLE_COMPARE, SEARCHABLE_LIKE

Method Summary

java.lang.String	getFormat() Get the Format property
java.lang.Object	getMaximumValue() Get maximum value
java.lang.Object	getMinimumValue() Get minimum value
java.lang.String	getNativeType() Get the native type imported for this column.
Group	getParent() Get the parent
int	getPosition() Get position of this element in it's group.
int	getSearchability() Get searchability of this column.
boolean	isAutoIncremented() Is auto-incremented?
boolean	isCaseSensitive() Is case sensitive?

Methods inherited from interface org.teiid.connector.metadata.runtime.MetadataObject

getFullName, getName, getNameInSource, getProperties

Methods inherited from interface org.teiid.connector.metadata.runtime.TypeModel

getDefaultValue, getJavaType, getLength, getModeledBaseType, getModeledPrimitiveType, getModeledType, getNullability, getPrecision, getScale

Method Detail

getPosition

int getPosition()
                throws ConnectorException

Get position of this element in it's group.

Returns:

Position, 0-based

Throws:

ConnectorException - If an error occurs retrieving the data from runtime metadata

getMinimumValue

java.lang.Object getMinimumValue()
                                 throws ConnectorException

Get minimum value

Returns:

Minimum value, may be null

Throws:

ConnectorException - If an error occurs retrieving the data from runtime metadata

getMaximumValue

java.lang.Object getMaximumValue()
                                 throws ConnectorException

Get maximum value

Returns:

Maximum value, may be null

Throws:

ConnectorException - If an error occurs retrieving the data from runtime metadata

isAutoIncremented

boolean isAutoIncremented()
                          throws ConnectorException

Is auto-incremented?

Returns:

True if auto-incremented, false otherwise

Throws:

ConnectorException - If an error occurs retrieving the data from runtime metadata

getSearchability

int getSearchability()
                     throws ConnectorException

Get searchability of this column.

Returns:

Code indicating searchability

Throws:

ConnectorException - If an error occurs retrieving the data from runtime metadata

See Also:

TypeModel.NOT_SEARCHABLE, TypeModel.SEARCHABLE, TypeModel.SEARCHABLE_COMPARE, TypeModel.SEARCHABLE_LIKE

isCaseSensitive

boolean isCaseSensitive()
                        throws ConnectorException

Is case sensitive?

Returns:

True if case sensitive, false otherwise

Throws:

ConnectorException - If an error occurs retrieving the data from runtime metadata

getNativeType

java.lang.String getNativeType()
                               throws ConnectorException

Get the native type imported for this column.

Returns:

The native type, may be null

Throws:

ConnectorException - If an error occurs retrieving the data

Since:

4.2

getFormat

java.lang.String getFormat()
                           throws ConnectorException

Get the Format property

Returns:

Throws:

ConnectorException

getParent

Group getParent()
                throws ConnectorException

Get the parent

Returns:

Parent

Throws:

ConnectorException