Module org.eclipse.persistence.jpa
Class OrderByMetadata
java.lang.Object
org.eclipse.persistence.internal.jpa.metadata.ORMetadata
org.eclipse.persistence.internal.jpa.metadata.mappings.OrderByMetadata
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.
- Since:
- EclipseLink 2.3
-
Field Summary
Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
m_project
-
Constructor Summary
ConstructorDescriptionINTERNAL: Used for XML loading.OrderByMetadata
(MetadataAnnotation orderBy, MetadataAccessor accessor) INTERNAL: Used for annotation loading. -
Method Summary
Modifier and TypeMethodDescriptionboolean
INTERNAL:getValue()
INTERNAL: Used for OX mapping.int
hashCode()
void
process
(CollectionMapping mapping, MetadataDescriptor referenceDescriptor, MetadataClass javaClass) INTERNAL: Process an order by value (if specified) for the given collection mapping.void
INTERNAL: Used for OX mapping.Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch
-
Constructor Details
-
OrderByMetadata
public OrderByMetadata()INTERNAL: Used for XML loading. -
OrderByMetadata
INTERNAL: Used for annotation loading.
-
-
Method Details
-
equals
INTERNAL:- Specified by:
equals
in classORMetadata
-
hashCode
public int hashCode() -
getValue
INTERNAL: Used for OX mapping. -
process
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. -
setValue
INTERNAL: Used for OX mapping.
-