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

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

JavaOrderable2_0, Orderable2_0, OrmOrderable2_0

public interface Orderable
extends JpaContextModel

Multi-valued (1:m, m:m) relationship mappings support ordering.

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.

Since:

2.3

Nested Class Summary

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	NO_ORDERING_PROPERTY String associated with changes to the "noOrdering" property
static String	ORDER_BY_ORDERING_PROPERTY String associated with changes to the "orderByOrdering" property

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

TRANSFORMER

Method Summary

OrderBy	getOrderBy() Return the orderBy object.
AttributeMapping	getParent() Return the JPA node's parent.
boolean	isNoOrdering() Will have no ordering if no other metadata is present
boolean	isOrderByOrdering() If true, will have orderBy metadata that takes precedence over other metadata
void	setNoOrdering() Will set noOrdering to true (will remove all other metadata)
void	setOrderByOrdering() Will set orderByOrdering to true (will remove all other metadata, and will set orderBy to null)

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, 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

NO_ORDERING_PROPERTY

static final String NO_ORDERING_PROPERTY

String associated with changes to the "noOrdering" property

See Also:

Constant Field Values

ORDER_BY_ORDERING_PROPERTY

static final String ORDER_BY_ORDERING_PROPERTY

String associated with changes to the "orderByOrdering" property

See Also:

Constant Field Values

Method Detail

getParent

AttributeMapping getParent()

Description copied from interface: JpaModel

Return the JPA node's parent. The JPA project will not have a parent.

Specified by:

getParent in interface JpaContextModel

Specified by:

getParent in interface JpaModel

isNoOrdering

boolean isNoOrdering()

Will have no ordering if no other metadata is present

setNoOrdering

void setNoOrdering()

Will set noOrdering to true (will remove all other metadata)

isOrderByOrdering

boolean isOrderByOrdering()

If true, will have orderBy metadata that takes precedence over other metadata

setOrderByOrdering

void setOrderByOrdering()

Will set orderByOrdering to true (will remove all other metadata, and will set orderBy to null)

getOrderBy

OrderBy getOrderBy()

Return the orderBy object. This will never be null.