org.eclipse.jpt.jpa.core.context
Interface NamedColumn

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

BaseColumn, BaseJoinColumn, Column, EclipseLinkJavaSpecifiedTenantDiscriminatorColumn2_3, EclipseLinkOrmSpecifiedTenantDiscriminatorColumn2_3, EclipseLinkSpecifiedTenantDiscriminatorColumn2_3, EclipseLinkTenantDiscriminatorColumn2_3, EclipseLinkVirtualTenantDiscriminatorColumn2_3, JavaSpecifiedBaseColumn, JavaSpecifiedBaseJoinColumn, JavaSpecifiedColumn, JavaSpecifiedDiscriminatorColumn, JavaSpecifiedJoinColumn, JavaSpecifiedNamedColumn, JavaSpecifiedOrderColumn2_0, JavaSpecifiedPrimaryKeyJoinColumn, JoinColumn, NamedDiscriminatorColumn, OrmSpecifiedBaseColumn, OrmSpecifiedBaseJoinColumn, OrmSpecifiedColumn, OrmSpecifiedDiscriminatorColumn, OrmSpecifiedJoinColumn, OrmSpecifiedNamedColumn, OrmSpecifiedOrderColumn2_0, OrmSpecifiedPrimaryKeyJoinColumn, OrmVirtualPrimaryKeyJoinColumn, PrimaryKeyJoinColumn, SpecifiedBaseColumn, SpecifiedBaseJoinColumn, SpecifiedColumn, SpecifiedDiscriminatorColumn, SpecifiedJoinColumn, SpecifiedNamedColumn, SpecifiedNamedDiscriminatorColumn, SpecifiedOrderColumn2_0, SpecifiedPrimaryKeyJoinColumn, SpecifiedTableColumn, TableColumn, VirtualBaseColumn, VirtualBaseJoinColumn, VirtualColumn, VirtualJoinColumn, VirtualNamedColumn, VirtualNamedDiscriminatorColumn, VirtualPrimaryKeyJoinColumn, VirtualTableColumn

public interface NamedColumn
extends JpaContextModel

• column
• join column
• primary key join column
• discriminator column
• order column

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Nested Class Summary

static interface

NamedColumn.ParentAdapter Interface allowing columns to be used in multiple places (e.g. basic mappings and attribute overrides).

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	COLUMN_DEFINITION_PROPERTY
static String	DB_TABLE_PROPERTY
static String	DEFAULT_NAME_PROPERTY
static String	SPECIFIED_NAME_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

String	getColumnDefinition()
Table	getDbTable() Return the column's datasource table.
String	getDefaultName()
String	getName() Return the specified name if present, otherwise return the default name.
TextRange	getNameValidationTextRange() Return the (best guess) text location of the column's name.
String	getSpecifiedName()
String	getTableName() Return the name of the column's table.
boolean	isResolved() Return whether the column is found on the datasource.
boolean	isVirtual() Return whether the column has a textual representation in its underlying resource.

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

SPECIFIED_NAME_PROPERTY

static final String SPECIFIED_NAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_NAME_PROPERTY

static final String DEFAULT_NAME_PROPERTY

See Also:

Constant Field Values

COLUMN_DEFINITION_PROPERTY

static final String COLUMN_DEFINITION_PROPERTY

See Also:

Constant Field Values

DB_TABLE_PROPERTY

static final String DB_TABLE_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

String getName()

Return the specified name if present, otherwise return the default name.

getSpecifiedName

String getSpecifiedName()

getDefaultName

String getDefaultName()

getNameValidationTextRange

TextRange getNameValidationTextRange()

Return the (best guess) text location of the column's name.

getTableName

String getTableName()

Return the name of the column's table. A column that does not have a specified table still has a table (as determined by the column's parent).

getColumnDefinition

String getColumnDefinition()

getDbTable

Table getDbTable()

Return the column's datasource table.

isResolved

boolean isResolved()

Return whether the column is found on the datasource.

isVirtual

boolean isVirtual()

Return whether the column has a textual representation in its underlying resource.