public abstract class MappingAccessor extends MetadataAccessor
Modifier and Type | Method and Description |
---|---|
boolean |
derivesId()
INTERNAL:
Return true is this accessor is a derived id accessor.
|
boolean |
equals(java.lang.Object objectToCompare)
INTERNAL:
For merging and overriding to work properly, all ORMetadata must be able
to compare themselves for metadata equality.
|
java.lang.String |
getAttributeName()
INTERNAL:
Return the attribute name for this accessor.
|
java.lang.String |
getAttributeType()
INTERNAL:
Used for OX mapping.
|
ClassAccessor |
getClassAccessor()
INTERNAL:
Returns the class accessor on which this mapping was defined.
|
EnumeratedMetadata |
getEnumerated(boolean isForMapKey)
INTERNAL:
Return the enumerated metadata for this accessor.
|
ColumnMetadata |
getField()
INTERNAL:
Used for OX mapping.
|
java.lang.String |
getGetMethodName()
INTERNAL:
Returns the get method name of a method accessor.
|
LobMetadata |
getLob(boolean isForMapKey)
INTERNAL:
Return the lob metadata for this accessor.
|
MapKeyMetadata |
getMapKey()
INTERNAL:
Return the map key if this mapping accessor employs one.
|
MetadataClass |
getMapKeyReferenceClass()
INTERNAL:
Return the map key reference class for this accessor if applicable.
|
java.lang.String |
getMapKeyReferenceClassName()
INTERNAL:
Return the map key reference class name
|
MetadataClass |
getMapKeyReferenceClassWithGenerics()
INTERNAL:
Return the map key reference class for this accessor if applicable.
|
DatabaseMapping |
getMapping()
INTERNAL:
Return the mapping that this accessor is associated to.
|
MetadataDescriptor |
getOwningDescriptor()
INTERNAL:
Return the owning descriptor of this accessor.
|
java.util.List<MetadataDescriptor> |
getOwningDescriptors()
INTERNAL:
Return the owning descriptors of this accessor.
|
MetadataClass |
getRawClass()
INTERNAL:
Return the raw class for this accessor.
|
MetadataClass |
getRawClassWithGenerics()
INTERNAL:
Return the raw class with any generic specifications for this accessor.
|
java.util.Collection<MappingAccessor> |
getReferenceAccessors()
INTERNAL:
Return the mapping accessors associated with the reference descriptor.
|
MetadataClass |
getReferenceClass()
INTERNAL:
Return the reference class for this accessor.
|
MetadataClass |
getReferenceClassFromGeneric()
INTERNAL:
Attempts to return a reference class from a generic specification.
|
java.lang.String |
getReferenceClassName()
INTERNAL:
Return the reference class name for this accessor.
|
MetadataClass |
getReferenceClassWithGenerics()
INTERNAL:
Return the reference class for this accessor.
|
MetadataDescriptor |
getReferenceDescriptor()
INTERNAL:
Return the reference metadata descriptor for this accessor.
|
java.lang.String |
getSetMethodName()
INTERNAL:
Returns the set method name of a method accessor.
|
TemporalMetadata |
getTemporal(boolean isForMapKey)
INTERNAL:
Return the temporal metadata for this accessor.
|
boolean |
hasAttributeType()
INTERNAL:
Those accessors that do not require a separate attribute-type
specification for VIRTUAL accessors should override this method.
|
boolean |
hasMapKey()
INTERNAL:
Method should be overridden by those accessors that accept and use a map
key.
|
boolean |
hasTemporal(boolean isForMapKey)
INTERNAL:
Return true if this accessor has temporal metadata.
|
void |
initXMLMappingAccessor(ClassAccessor classAccessor)
INTERNAL:
Init an xml mapping accessor with its necessary components.
|
void |
initXMLObject(MetadataAccessibleObject accessibleObject,
XMLEntityMappings entityMappings)
INTERNAL:
|
boolean |
isAnnotationPresent(java.lang.String annotation)
INTERNAL:
Indicates whether the specified annotation is present on the annotated
element for this accessor.
|
boolean |
isBasic()
INTERNAL:
Return true if this accessor represents a basic mapping.
|
boolean |
isBasicCollection()
INTERNAL:
Return true if this accessor represents a basic collection mapping.
|
boolean |
isBasicMap()
INTERNAL:
Return true if this accessor represents a basic map mapping.
|
boolean |
isCollectionAccessor()
INTERNAL:
Return true if this accessor represents a collection accessor.
|
boolean |
isDerivedIdClass()
INTERNAL:
Return true if this accessor is a derived id class accessor.
|
boolean |
isDirectCollection()
INTERNAL:
Return true if this accessor represents a direct collection mapping,
which include basic collection, basic map and element collection
accessors.
|
boolean |
isDirectEmbeddableCollection()
INTERNAL:
Return true if this accessor represents an element collection that
contains embeddable objects.
|
boolean |
isEmbedded()
INTERNAL:
Return true if this accessor represents an aggregate mapping.
|
boolean |
isEmbeddedId()
INTERNAL:
Return true if this accessor represents an aggregate id mapping.
|
boolean |
isId()
INTERNAL:
Return true if this accessor is part of the id.
|
boolean |
isManyToMany()
INTERNAL:
Return true if this accessor represents a m-m relationship.
|
boolean |
isManyToOne()
INTERNAL:
Return true if this accessor represents a m-1 relationship.
|
boolean |
isMapAccessor()
INTERNAL:
Return true if this accessor uses a Map.
|
boolean |
isMappedKeyMapAccessor()
INTERNAL:
Return true if this accessor is a mapped key map accessor.
|
boolean |
isMultitenantId()
INTERNAL:
Return true if this accessor is a multitenant id mapping.
|
boolean |
isOneToMany()
INTERNAL:
Return true if this accessor represents a 1-m relationship.
|
boolean |
isOneToOne()
INTERNAL:
Return true if this accessor represents a 1-1 relationship.
|
boolean |
isProcessed()
INTERNAL:
Return true if this accessor has been processed.
|
boolean |
isRelationship()
INTERNAL:
Return true if this accessor method represents a relationship.
|
boolean |
isSerialized(MetadataClass referenceClass,
boolean isForMapKey)
INTERNAL:
Return true if this accessor represents a serialized mapping.
|
boolean |
isTransient()
INTERNAL:
Return true if this accessor represents a transient mapping.
|
boolean |
isVariableOneToOne()
INTERNAL:
Return true if this accessor represents a variable one to one mapping.
|
void |
setAttributeType(java.lang.String attributeType)
INTERNAL:
Used for OX mapping.
|
void |
setClassAccessor(ClassAccessor classAccessor)
INTERNAL:
Sets the class accessor for this mapping accessor.
|
void |
setField(ColumnMetadata column)
INTERNAL:
Used for OX mapping.
|
java.lang.String |
toString()
INTERNAL:
|
boolean |
usesFieldAccess()
INTERNAL:
Returns true if this mapping or class uses property field.
|
boolean |
usesPropertyAccess()
INTERNAL:
Returns true if this mapping or class uses property access.
|
boolean |
usesVirtualAccess()
INTERNAL:
Returns true if this mapping or class uses virtual access.
|
getAccess, getAccessibleObject, getAccessMethods, getAnnotatedElement, getAnnotatedElementName, getAnnotation, getConverters, getDescriptor, getDescriptorJavaClass, getHashPartitioning, getIdentifier, getJavaClass, getName, getObjectTypeConverters, getPartitioned, getPartitioning, getPinnedPartitioning, getProperties, getRangePartitioning, getReplicationPartitioning, getRoundRobinPartitioning, getSerializedConverters, getStructConverters, getTypeConverters, getUnionPartitioning, getValuePartitioning, hasAccess, hasAccessMethods, initAccess, initXMLAccessor, isAnnotationPresent, merge, process, processConverters, processPartitioned, setAccess, setAccessMethods, setConverters, setDescriptor, setHashPartitioning, setName, setObjectTypeConverters, setPartitioned, setPartitioning, setPinnedPartitioning, setProperties, setRangePartitioning, setReplicationPartitioning, setRoundRobinPartitioning, setSerializedConverters, setStructConverters, setTypeConverters, setUnionPartitioning, setValuePartitioning
getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride
public boolean derivesId()
ObjectAccessor
public boolean equals(java.lang.Object objectToCompare)
equals
in class MetadataAccessor
public java.lang.String getAttributeName()
getAttributeName
in class MetadataAccessor
public java.lang.String getAttributeType()
public ClassAccessor getClassAccessor()
public EnumeratedMetadata getEnumerated(boolean isForMapKey)
public ColumnMetadata getField()
public java.lang.String getGetMethodName()
public LobMetadata getLob(boolean isForMapKey)
DirectAccessor
public DatabaseMapping getMapping()
public MetadataDescriptor getOwningDescriptor()
public java.util.List<MetadataDescriptor> getOwningDescriptors()
public MapKeyMetadata getMapKey()
CollectionAccessor
,
ElementCollectionAccessor
public MetadataClass getMapKeyReferenceClass()
public java.lang.String getMapKeyReferenceClassName()
public MetadataClass getMapKeyReferenceClassWithGenerics()
public MetadataClass getRawClass()
public MetadataClass getRawClassWithGenerics()
public java.util.Collection<MappingAccessor> getReferenceAccessors()
public MetadataClass getReferenceClass()
public MetadataClass getReferenceClassWithGenerics()
public MetadataClass getReferenceClassFromGeneric()
public java.lang.String getReferenceClassName()
public MetadataDescriptor getReferenceDescriptor()
public java.lang.String getSetMethodName()
public TemporalMetadata getTemporal(boolean isForMapKey)
DirectAccessor
,
CollectionAccessor
public boolean hasAttributeType()
public boolean hasMapKey()
public boolean hasTemporal(boolean isForMapKey)
public void initXMLMappingAccessor(ClassAccessor classAccessor)
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)
initXMLObject
in class MetadataAccessor
public boolean isAnnotationPresent(java.lang.String annotation)
isAnnotationPresent
in class MetadataAccessor
public boolean isBasic()
public boolean isBasicCollection()
public boolean isBasicMap()
public boolean isDerivedIdClass()
public boolean isDirectCollection()
public boolean isDirectEmbeddableCollection()
public boolean isCollectionAccessor()
public boolean isEmbedded()
public boolean isEmbeddedId()
public boolean isId()
public boolean isManyToMany()
public boolean isManyToOne()
public boolean isMapAccessor()
public boolean isMappedKeyMapAccessor()
public boolean isMultitenantId()
public boolean isOneToMany()
public boolean isOneToOne()
public boolean isProcessed()
isProcessed
in class MetadataAccessor
public boolean isRelationship()
public boolean isSerialized(MetadataClass referenceClass, boolean isForMapKey)
public boolean isTransient()
public boolean isVariableOneToOne()
public void setAttributeType(java.lang.String attributeType)
public void setClassAccessor(ClassAccessor classAccessor)
public void setField(ColumnMetadata column)
public java.lang.String toString()
toString
in class java.lang.Object
public boolean usesPropertyAccess()
public boolean usesVirtualAccess()
public boolean usesFieldAccess()
EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference