org.eclipse.persistence.internal.jpa.metadata.accessors.objects

Class MetadataField

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataField

public class MetadataField
extends MetadataAnnotatedElement

INTERNAL: An object to hold onto a valid JPA decorated field.

Since:

TopLink 10.1.3/EJB 3.0 Preview

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field and Description
protected MetadataClass	declaringClass

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement

DEFAULT_RAW_CLASS

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

m_factory

Constructor Summary

Constructors

Constructor and Description
MetadataField(MetadataClass metadataClass) INTERNAL:

Method Summary

Modifier and Type	Method and Description
MetadataClass	getDeclaringClass() INTERNAL:
boolean	isEclipseLinkWeavedField() INTERNAL: Used to determine if this is a field EclipseLink weaved into the class.
boolean	isValidPersistenceField(boolean mustBeExplicit, ClassAccessor classAccessor) INTERNAL: Return true is this field is a valid persistence field.
boolean	isValidPersistenceField(ClassAccessor classAccessor, boolean userDecorated) INTERNAL: Return true is this field is a valid persistence field.
void	setDeclaringClass(MetadataClass declaringClass) INTERNAL:
boolean	shouldBeIgnored() INTERNAL Some fields should automatically be ignored, return true if this field should be ignored

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement

addAnnotation, addGenericType, addMetaAnnotation, areAnnotationsCompatibleWithTransient, equals, getAnnotation, getAnnotation, getAnnotation, getAnnotation, getAnnotations, getAttributeName, getDeclaredAnnotationsCount, getGenericType, getMapKeyClass, getModifiers, getName, getPrimitiveType, getRawClass, getRawClassWithGenerics, getReferenceClassFromGeneric, getType, hasDeclaredAnnotations, hashCode, isAnnotationNotPresent, isAnnotationNotPresent, isAnnotationPresent, isAnnotationPresent, isAnnotationPresent, isArray, isBasic, isBasicCollection, isBasicMap, isDerivedId, isDerivedIdClass, isElementCollection, isEmbedded, isEmbeddedId, isGenericCollectionType, isGenericType, isId, isManyToMany, isManyToOne, isOneToMany, isOneToOne, isStructure, isSupportedCollectionClass, isSupportedMapClass, isSupportedToManyCollectionClass, isTransformation, isValidPersistenceElement, isValidPersistenceElement, isVariableOneToOne, isVersion, setAnnotations, setAttributeName, setGenericType, setModifiers, setName, setPrimitiveType, setType, toString

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

getLogger, getMetadataClass, getMetadataFactory, setMetadataFactory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

declaringClass

protected MetadataClass declaringClass

Constructor Detail

MetadataField

public MetadataField(MetadataClass metadataClass)

INTERNAL:

Method Detail

getDeclaringClass

public MetadataClass getDeclaringClass()

INTERNAL:

isEclipseLinkWeavedField

public boolean isEclipseLinkWeavedField()

INTERNAL: Used to determine if this is a field EclipseLink weaved into the class.

Returns:

isValidPersistenceField

public boolean isValidPersistenceField(boolean mustBeExplicit,
                                       ClassAccessor classAccessor)

INTERNAL: Return true is this field is a valid persistence field. This method will validate against any declared annotations on the field. If the mustBeExplicit flag is true, then we are processing the inverse of an explicit access setting and the field must have an Access(FIELD) setting to be processed. Otherwise, it is ignored.

isValidPersistenceField

public boolean isValidPersistenceField(ClassAccessor classAccessor,
                                       boolean userDecorated)

INTERNAL: Return true is this field is a valid persistence field. User decorated is used to indicate that the field either had persistence annotations defined on it or that it was specified in XML.

setDeclaringClass

public void setDeclaringClass(MetadataClass declaringClass)

INTERNAL:

shouldBeIgnored

public boolean shouldBeIgnored()

INTERNAL Some fields should automatically be ignored, return true if this field should be ignored

Returns: