Interface AttributeNode<T>

Type Parameters:

T - The type of the attribute.

public interface AttributeNode<T>

Represents an attribute node of an entity graph.

Since:

2.1

See Also:

• EntityGraph
• Subgraph
• NamedAttributeNode

Method Summary

Modifier and Type	Method	Description
AttributeNode<T>	addOption(FetchOption option)	Specify an option controlling how this node is fetched.
Subgraph<T>	addSubgraph()	Add a subgraph rooted at this attribute node, which must be an embedded attribute or an association to an entity class.
<S extends T> Subgraph<S>	addTreatedSubgraph(Class<S> type)	Add a subgraph rooted at this attribute node, which must be an association to an entity class, for an entity subclass of the entity class.
Attribute<?,T>	getAttribute()	The attribute from which this branch of the graph or subgraph is forked.
String	getAttributeName()	Return the name of the attribute corresponding to the attribute node.
Map<Class<?>, Subgraph<?>>	getKeySubgraphs()	Return a map of subgraphs associated with this attribute node's map key.
Set<FetchOption>	getOptions()	Return the options controlling how this node is fetched.
Map<Class<?>, Subgraph<?>>	getSubgraphs()	Return a map of subgraphs associated with this attribute node.

Method Details

getAttributeName

String getAttributeName()

Return the name of the attribute corresponding to the attribute node.

Returns:

name of the attribute

getAttribute

Attribute<?,T> getAttribute()

The attribute from which this branch of the graph or subgraph is forked.

Returns:

The metamodel object representing the graphed attribute

Since:

4.0

addSubgraph

Subgraph<T> addSubgraph()

Add a subgraph rooted at this attribute node, which must be an embedded attribute or an association to an entity class.

Returns:

the added subgraph

Since:

4.0

See Also:

• Graph.addSubgraph(Attribute)

addTreatedSubgraph

<S extends T> Subgraph<S> addTreatedSubgraph(Class<S> type)

Add a subgraph rooted at this attribute node, which must be an association to an entity class, for an entity subclass of the entity class.

Type Parameters:

S - The type of the subclass

Parameters:

type - The subclass of the entity class

Returns:

the added subgraph

Since:

4.0

See Also:

• Graph.addTreatedSubgraph(Attribute, Class)

getSubgraphs

Map<Class<?>, Subgraph<?>> getSubgraphs()

Return a map of subgraphs associated with this attribute node.

Returns:

a Map of subgraphs associated with this attribute node or an empty Map if none have been defined

getKeySubgraphs

Map<Class<?>, Subgraph<?>> getKeySubgraphs()

Return a map of subgraphs associated with this attribute node's map key.

Returns:

a Map of subgraphs associated with this attribute node's map key or an empty Map if none have been defined

addOption

AttributeNode<T> addOption(FetchOption option)

Specify an option controlling how this node is fetched.

Parameters:

option - The option

Returns:

the receiving instance

Since:

4.0

getOptions

Set<FetchOption> getOptions()

Return the options controlling how this node is fetched.

• If this is an added node, the returned options contain FetchType.EAGER.
• If this is a removed node, the returned options contain FetchType.LAZY.

Returns:

The options for this node

Since:

4.0