org.batoo.jpa.parser.impl.orm.attribute

Class AssociationElement

java.lang.Object

org.batoo.jpa.parser.impl.orm.ElementConstants

org.batoo.jpa.parser.impl.orm.Element

org.batoo.jpa.parser.impl.orm.ParentElement

org.batoo.jpa.parser.impl.orm.attribute.AttributeElement

org.batoo.jpa.parser.impl.orm.attribute.AssociationElement

All Implemented Interfaces:

AssociationMetadata, AssociationAttributeMetadata, AttributeMetadata, BindableMetadata, LocatableMatadata

Direct Known Subclasses:

ManyToManyAttributeElement, ManyToOneAttributeElement, OneToManyAttributeElement, OneToOneAttributeElement

public abstract class AssociationElement
extends AttributeElement
implements AssociationAttributeMetadata

Element for one-to-one elements.

Since:

2.0.0

Author:

hceylan

Field Summary

Fields inherited from class org.batoo.jpa.parser.impl.orm.ElementConstants

ATTR_ACCESS, ATTR_ALLOCATION_SIZE, ATTR_CACHABLE, ATTR_CATALOG, ATTR_CLASS, ATTR_COLUMN, ATTR_COLUMN_DEFINITION, ATTR_DISCRIMINATOR_COLUMN, ATTR_DISCRIMINATOR_TYPE, ATTR_ENTITY_CLASS, ATTR_FETCH, ATTR_GENERATOR, ATTR_ID, ATTR_INITIAL_VALUE, ATTR_INSERTABLE, ATTR_LENGTH, ATTR_MAPPED_BY, ATTR_MAPS_ID, ATTR_METADATA_COMPLETE, ATTR_NAME, ATTR_NULLABLE, ATTR_OPTIONAL, ATTR_ORPHAN_REMOVAL, ATTR_PK_COLUMN_NAME, ATTR_PK_COLUMN_VALUE, ATTR_PRECISION, ATTR_REFERENCED_COLUMN_NAME, ATTR_RESULT_CLASS, ATTR_RESULT_SET_MAPPING, ATTR_SCALE, ATTR_SCHEMA, ATTR_SEQUENCE_NAME, ATTR_STRATEGY, ATTR_TABLE, ATTR_TARGET_CLASS, ATTR_TARGET_ENTITY, ATTR_UNIQUE, ATTR_UPDATABLE, ATTR_VALUE, ATTR_VALUE_COLUMN_NAME, ELEMENT_ACCESS, ELEMENT_ASSOCIATION_OVERRIDE, ELEMENT_ATTRIBUTE_OVERRIDE, ELEMENT_ATTRIBUTES, ELEMENT_BASIC, ELEMENT_CASCADE, ELEMENT_CASCADE_ALL, ELEMENT_CASCADE_DETACH, ELEMENT_CASCADE_MERGE, ELEMENT_CASCADE_PERSIST, ELEMENT_CASCADE_REFRESH, ELEMENT_CASCADE_REMOVE, ELEMENT_CATALOG, ELEMENT_COLLECTION_TABLE, ELEMENT_COLUMN, ELEMENT_COLUMN_NAME, ELEMENT_COLUMN_RESULT, ELEMENT_DISCRIMINATOR_COLUMN, ELEMENT_DISCRIMINATOR_VALUE, ELEMENT_ELEMENT_COLLECTION, ELEMENT_EMBEDDABLE, ELEMENT_EMBEDDED, ELEMENT_EMBEDDED_ID, ELEMENT_ENTITY, ELEMENT_ENTITY_LISTENER, ELEMENT_ENTITY_LISTENERS, ELEMENT_ENTITY_MAPPINGS, ELEMENT_ENTITY_RESULT, ELEMENT_ENUMERATED, ELEMENT_EXCLUDE_DEFAULT_LISTENERS, ELEMENT_EXCLUDE_SUPERCLASS_LISTENERS, ELEMENT_FIELD_RESULT, ELEMENT_GENERATED_VALUE, ELEMENT_HINT, ELEMENT_ID, ELEMENT_ID_CLASS, ELEMENT_INHERITANCE, ELEMENT_INVERSE_JOIN_COLUMN, ELEMENT_JOIN_COLUMN, ELEMENT_JOIN_TABLE, ELEMENT_LOB, ELEMENT_LOCK_MODE, ELEMENT_MANY_TO_MANY, ELEMENT_MANY_TO_ONE, ELEMENT_MAP_KEY, ELEMENT_MAP_KEY_ATTRIBUTE_OVERRIDE, ELEMENT_MAP_KEY_CLASS, ELEMENT_MAP_KEY_COLUMN, ELEMENT_MAP_KEY_ENUMERATED, ELEMENT_MAP_KEY_TEMPORAL, ELEMENT_MAPPED_SUPERCLASS, ELEMENT_NAMED_NATIVE_QUERY, ELEMENT_NAMED_QUERY, ELEMENT_ONE_TO_MANY, ELEMENT_ONE_TO_ONE, ELEMENT_ORDER_BY, ELEMENT_ORDER_COLUMN, ELEMENT_PERSISTENCE_UNIT_DEFAULTS, ELEMENT_PERSISTENT_UNIT_METADATA, ELEMENT_POST_LOAD, ELEMENT_POST_PERSIST, ELEMENT_POST_REMOVE, ELEMENT_POST_UPDATE, ELEMENT_PRE_PERSIST, ELEMENT_PRE_REMOVE, ELEMENT_PRE_UPDATE, ELEMENT_PRIMARY_KEY_JOIN_COLUMN, ELEMENT_QUERY, ELEMENT_SCHEMA, ELEMENT_SECONDARY_TABLE, ELEMENT_SEQUENCE_GENERATOR, ELEMENT_SQL_RESULT_SET_MAPPING, ELEMENT_TABLE, ELEMENT_TABLE_GENERATOR, ELEMENT_TEMPORAL, ELEMENT_TRANSIENT, ELEMENT_UNIQUE_CONSTRAINT, ELEMENT_VERSION, ELEMENT_XML_MAPPING_METADATA_COMPLETE, EMPTY, FALSE

Constructor Summary

Constructors

Constructor and Description
AssociationElement(ParentElement parent, Map<String,String> attributes, javax.persistence.FetchType defaultFetchType, String... expectedChildElements)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	generate() Generates the elements artifact.
Set<javax.persistence.CascadeType>	getCascades() Returns the cascades of the association attribute.
FetchStrategyType	getFetchStrategy() Returns the fetching strategy for eager joins.
javax.persistence.FetchType	getFetchType() Returns the fetch type of the association attribute.
List<JoinColumnMetadata>	getJoinColumns() Returns the list of join column definition.
JoinTableMetadata	getJoinTable() Returns the join table definition.
int	getMaxFetchDepth() Returns the max fetch depth for eager joins.
String	getTargetEntity() Returns the name of the target entity of the association attribute.
protected void	handleChild(Element child) Handles the generated artifact of the child element.

Methods inherited from class org.batoo.jpa.parser.impl.orm.attribute.AttributeElement

equals, getAccess, getName, hashCode

Methods inherited from class org.batoo.jpa.parser.impl.orm.ParentElement

join, toString

Methods inherited from class org.batoo.jpa.parser.impl.orm.Element

cdata, end, expected, forElement, getAttribute, getAttribute, getAttribute, getAttribute, getExpectedChildElements, getLocator, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.batoo.jpa.parser.metadata.attribute.AttributeMetadata

getAccess

Methods inherited from interface org.batoo.jpa.parser.metadata.BindableMetadata

getName

Methods inherited from interface org.batoo.jpa.parser.metadata.LocatableMatadata

getLocator

Constructor Detail

AssociationElement

public AssociationElement(ParentElement parent,
                  Map<String,String> attributes,
                  javax.persistence.FetchType defaultFetchType,
                  String... expectedChildElements)

Parameters:

parent - the parent element factory

attributes - the attributes

defaultFetchType - the default fetch type

expectedChildElements - the name of the elements expected

Since:

2.0.0

Method Detail

generate

protected void generate()

Generates the elements artifact.

Element factories implement the method to generate their artifacts.

Overrides:

generate in class AttributeElement

getCascades

public Set<javax.persistence.CascadeType> getCascades()

Returns the cascades of the association attribute.

Specified by:

getCascades in interface AssociationAttributeMetadata

Returns:

the cascades of the association attribute

getFetchStrategy

public FetchStrategyType getFetchStrategy()

Returns the fetching strategy for eager joins.

Specified by:

getFetchStrategy in interface AssociationAttributeMetadata

Returns:

the fetching strategy for eager joins

getFetchType

public javax.persistence.FetchType getFetchType()

Returns the fetch type of the association attribute.

Specified by:

getFetchType in interface AssociationAttributeMetadata

Returns:

the fetch type of the association attribute

getJoinColumns

public List<JoinColumnMetadata> getJoinColumns()

Returns the list of join column definition.

Specified by:

getJoinColumns in interface AssociationMetadata

Returns:

the list of join column definition

getJoinTable

public JoinTableMetadata getJoinTable()

Returns the join table definition.

Specified by:

getJoinTable in interface AssociationMetadata

Returns:

the join table definition

getMaxFetchDepth

public int getMaxFetchDepth()

Returns the max fetch depth for eager joins.

Specified by:

getMaxFetchDepth in interface AssociationAttributeMetadata

Returns:

the max fetch depth for eager joins

getTargetEntity

public String getTargetEntity()

Returns the name of the target entity of the association attribute.

Specified by:

getTargetEntity in interface AssociationAttributeMetadata

Returns:

the name of the target entity of the association attribute

handleChild

protected void handleChild(Element child)

Handles the generated artifact of the child element.

Element factories implement the method to generate their artifacts.

Specified by:

handleChild in class ParentElement

Parameters:

child - the generated child artifact