Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.mappings

public Class OrderByMetadata

extends ORMetadata
Class Inheritance
Imports
java.util.List, .StringTokenizer, org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, .MetadataClass, org.eclipse.persistence.mappings.CollectionMapping, .DirectCollectionMapping
Object to hold onto order by metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.
Author
Guy Pelletier
Since
EclipseLink 2.3

Field Summary

Modifier and TypeField and Description
private static final String
ASCENDING

private static final String
DESCENDING

private String
m_value

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
OrderByMetadata()

INTERNAL: Used for XML loading.

public
OrderByMetadata(MetadataAnnotation orderBy, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:
public String
getValue()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
process(CollectionMapping mapping, MetadataDescriptor referenceDescriptor, MetadataClass javaClass)

INTERNAL: Process an order by value (if specified) for the given collection mapping.

public void
setValue(String value)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetIdentifiergetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

ASCENDINGback to summary
private static final String ASCENDING
DESCENDINGback to summary
private static final String DESCENDING
m_valueback to summary
private String m_value

Constructor Detail

OrderByMetadataback to summary
public OrderByMetadata()

INTERNAL: Used for XML loading.

OrderByMetadataback to summary
public OrderByMetadata(MetadataAnnotation orderBy, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getValueback to summary
public String getValue()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
processback to summary
public void process(CollectionMapping mapping, MetadataDescriptor referenceDescriptor, MetadataClass javaClass)

INTERNAL: Process an order by value (if specified) for the given collection mapping. Order by specifies the ordering of the elements of a collection valued association at the point when the association is retrieved. The syntax of the value ordering element is an orderby_list, as follows: orderby_list ::= orderby_item [, orderby_item]* orderby_item ::= property_or_field_name [ASC | DESC] When ASC or DESC is not specified, ASC is assumed. If the ordering element is not specified, ordering by the primary key of the associated entity is assumed. The property or field name must correspond to that of a persistent property or field of the associated class. The properties or fields used in the ordering must correspond to columns for which comparison operators are supported.

setValueback to summary
public void setValue(String value)

INTERNAL: Used for OX mapping.