Internal Website Search

Accessiblity of attributes in entities in several OSGi-Bundles

) Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass. Parameters: type - the type of the represented declared id attribute Return: declared id attribute Throws: IllegalArgumentException - if id attribute of the given type is not declared in

. Since: JPA 2.0 Public Methods SingularAttribute getDeclaredId (Class  type) Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass. Parameters: type - the type of the represented declared id attribute Return: declared id attribute Throws

Super Interfaces: FetchParent Represents a join-fetched association or attribute . Since: JPA 2.0 Public Methods Fetch fetch ( PluralAttribute   attribute ) Create a fetch join to the specified collection-valued attribute using an inner join. Parameters: attribute - target of the join Return

JPA Interface SingularAttribute Type Parameters: - The type containing the represented attribute - The type of the represented attribute Super Interfaces: Attribute , Bindable Instances of the type ... type of the object is PLURAL_ ATTRIBUTE , the Java element type is returned. If the bindable type

conversion of the following: Id attributes , version attributes , relationship attributes , and attributes explicitly denoted as Enumerated or Temporal. Applications that specify such conversions will not be portable. The Convert annotation may be applied to a basic attribute or to an element

Fetch fetch ( PluralAttribute   attribute ) Create a fetch join to the specified collection-valued attribute using an inner join. Parameters: attribute - target of the join Return: the resulting join Since: JPA 2.0 Fetch fetch ( PluralAttribute   attribute ,  JoinType  jt) Create

(Path   attribute ,  Expression  value) Update the value of the specified attribute . Parameters: attribute - attribute to be updated value - new value Return: the modified update query Since: JPA 2.1 CriteriaUpdate set (Path   attribute , X value) Update the value

compound attribute path from a bound type or collection, and is a "primitive" expression. Since: JPA 2.0 ... attribute . Parameters: map - map-valued attribute Return: expression corresponding to the referenced attribute Since: JPA 2.0 Expression get ( PluralAttribute  collection) Create a path corresponding

to all mapped attributes of the specified target type for all entities in the persistence unit except for attributes for which conversion is overridden by means of the Convert annotation (or XML equivalent). In determining whether a converter is applicable to an attribute , the provider must treat

JPA Interface AttributeNode Type Parameters: - The type of the attribute . Represents an attribute ... Methods String getAttributeName () Return the name of the attribute corresponding to the attribute node. Return: name of the attribute Since: JPA 2.1 Map getKeySubgraphs () Return the Map of subgraphs

a ManyToOne or OneToOne relationship attribute that provides the mapping for an EmbeddedId primary key, an attribute within an EmbeddedId primary key, or a simple primary key of the parent entity. The value element specifies the attribute within a composite key to which the relationship attribute

JPA Interface AttributeConverter Type Parameters: - the type of the entity attribute - the type of the database column A class that implements this interface can be used to convert entity attribute ... may be the same Java type. Since: JPA 1.0 Public Methods Y convertToDatabaseColumn (X  attribute ) Converts

the path and boundaries for a find operation or query. Since: JPA 2.1 Public Annotation Attributes NamedAttributeNode [] attributeNodes default {} (Optional) A list of attributes of the entity ... ) Includes all of the attributes of the annotated entity class as attribute nodes in the NamedEntityGraph

to determine the load state of an entity or entity attribute regardless of which persistence provider in ... of an entity passed as a reference. An entity is considered loaded if all attributes for which FetchType.EAGER ... to determine the load state of an attribute . Not doing so might lead to unintended loading of state. Parameters

Annotation Attributes String keySubgraph default "" (Optional) If the attribute references a Map type ... . A keySubgraph can not be specified without the Map attribute also being specified. If the target type ... subclass-specific attributes . Superclass subgraph entries will be merged into subclass subgraphs

JPA Method in javax.persistence.metamodel.SingularAttribute boolean isId () Is the attribute an id attribute . This method will return true if the attribute is an attribute that corresponds to a simple id, an embedded id, or an attribute of an id class. Return: boolean indicating whether the attribute is an id Since: JPA 2.0

the load state of an entity passed as a reference. An entity is considered loaded if all attributes ... should be used to determine the load state of an attribute . Not doing so might lead to unintended loading ... ;String attributeName) Determine the load state of a given persistent attribute of an entity

that include related managed types. Subclass subgraphs will include the specified attributes of superclass subgraphs Parameters: attributeName - name of the attribute type - entity subclass Return: subgraph for the attribute Throws: IllegalArgumentException - if the attribute is not an attribute

of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs Parameters: attributeName - name of the attribute type - entity subclass Return: subgraph for the attribute Throws: IllegalArgumentException - if the attribute is not an attribute

attributes of superclass subgraphs Parameters: attributeName - name of the attribute type - entity subclass Return: subgraph for the key attribute Throws: IllegalArgumentException - if the attribute is not an attribute of this entity. IllegalArgumentException - if the attribute's target type is not

of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs. Parameters: attributeName - name of the attribute type - entity subclass Return: subgraph for the attribute Throws: IllegalArgumentException - if the attribute is not an attribute

class (or embeddable class of one of its attributes ). May be applied to an element collection ... the name of the attribute that is being overridden in order to specify it as part of the map key or map ... in the name element to indicate an attribute within an embedded attribute . The value of each

JPA Interface Bindable Type Parameters: - The type of the represented object or attribute Instances of the type Bindable represent object or attribute types that can be bound into a javax ... of the represented object. If the bindable type of the object is PLURAL_ ATTRIBUTE , the Java element

to refer to an attribute within an embedded attribute . The value of each identifier used ... to specify the attribute or attributes that determine the ordering. The OrderBy annotation is not used ... ; } See Also: OrderColumn Since: JPA 1.0 Public Annotation Attributes String value default "" An orderby

to indicate an attribute within an embedded attribute . The value of each identifier used with the dot ... the name of the attribute within the embeddable class that is being overridden in order to specify ... AttributeOverride Since: JPA 1.0 Public Annotation Attributes ForeignKey foreignKey default

of the attribute Return: subgraph for the attribute Throws: IllegalArgumentException - if the attribute is not an attribute of this managed type. IllegalArgumentException - if the attribute's target type

: attributeName - name of the attribute Return: subgraph for the key attribute Throws: IllegalArgumentException - if the attribute is not an attribute of this entity. IllegalArgumentException - if the attribute's target type is not a managed type IllegalStateException - if this EntityGraph has been statically defined Since: JPA 2.1

: attributeName - name of the attribute Return: subgraph for the key attribute Throws: IllegalArgumentException - if the attribute is not an attribute of this entity. IllegalArgumentException - if the attribute's target type is not an entity IllegalStateException - if this EntityGraph has been statically defined Since: JPA 2.1

of the attribute Return: subgraph for the attribute Throws: IllegalArgumentException - if the attribute is not an attribute of this entity. IllegalArgumentException - if the attribute's target type is not

JPA Method in javax.persistence.metamodel.ManagedType Attribute getDeclaredAttribute (   String name ) Return the attribute declared by the managed type that corresponds to the specified name. Parameters: name - the name of the represented attribute Return: attribute with given name

JPA Method in javax.persistence.metamodel.ManagedType Attribute getAttribute (   String name ) Return the attribute of the managed type that corresponds to the specified name. Parameters: name - the name of the represented attribute Return: attribute with given name Throws

the Map-valued attribute of the managed type that corresponds to the specified name and Java key and value types. Parameters: name - the name of the represented attribute keyType - the key type of the represented attribute valueType - the value type of the represented attribute Return: MapAttribute

) Return the Map-valued attribute declared by the managed type that corresponds to the specified name and Java key and value types. Parameters: name - the name of the represented attribute keyType - the key type of the represented attribute valueType - the value type of the represented attribute Return

(   String name,    Class  type ) Return the single-valued attribute ... of the represented attribute type - the type of the represented attribute Return: single-valued attribute with given name and type Throws: IllegalArgumentException - if attribute of the given name

attribute declared by the managed type that corresponds to the specified name and Java type. Parameters: name - the name of the represented attribute type - the type of the represented attribute Return: declared single-valued attribute of the given name and type Throws: IllegalArgumentException

;Class  type ) Return the attribute that corresponds to the id attribute of the entity or mapped superclass. Parameters: type - the type of the represented id attribute Return: id attribute Throws: IllegalArgumentException - if id attribute of the given type is not present in the identifiable

JPA Annotation Attribute in javax.persistence.NamedEntityGraph boolean includeAllAttributes default false (Optional) Includes all of the attributes of the annotated entity class as attribute nodes in the NamedEntityGraph without the need to explicitly list them. Included attributes

(   Class  type ) Return the attribute that corresponds to the version attribute ... version attribute Return: declared version attribute Throws: IllegalArgumentException - if version attribute of the type is not declared in the identifiable type Since: JPA 2.0

; Class  type ) Return the attribute that corresponds to the version attribute of the entity or mapped superclass. Parameters: type - the type of the represented version attribute Return: version attribute Throws: IllegalArgumentException - if version attribute of the given type is not present in the identifiable type Since: JPA 2.0

; Class  type ) Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass. Parameters: type - the type of the represented declared id attribute Return: declared id attribute Throws: IllegalArgumentException - if id attribute of the given type

attribute Since: JPA 2.0 LIST List-valued attribute Since: JPA 2.0 MAP Map-valued attribute Since: JPA 2.0 SET Set-valued attribute Since: JPA 2.0 Public Static Enum Methods: PluralAttribute$CollectionType

JPA Method in javax.persistence.metamodel.SingularAttribute boolean isVersion () Is the attribute a version attribute . Return: boolean indicating whether the attribute is a version attribute Since: JPA 2.0

attribute . Parameters: entity - entity containing the attribute attributeName - name of attribute whose load state is to be determined Return: false if entity's state has not been loaded or if the attribute state has not been loaded, else true Since: JPA 2.0

) Create a path corresponding to the referenced attribute . Note: Applications using the string-based ... (p) .where(cb.isMember("joe", nicknames)); Parameters: attributeName - name of the attribute Return: path corresponding to the referenced attribute Throws: IllegalStateException - if invoked on a path

attribute of an entity belonging to the persistence unit. Parameters: entity - entity instance containing the attribute attributeName - name of attribute whose load state is to be determined Return: false if entity's state has not been loaded or if the attribute state has not been loaded, else true Since: JPA 2.0

JPA Enum BindableType java.lang.Object ∟  java.lang.Enum ∟  javax.persistence.metamodel.Bindable $BindableType Since: JPA 2.0 Enum Constants ENTITY_TYPE Entity type Since: JPA 2.0 PLURAL_ ATTRIBUTE Multi-valued attribute type Since: JPA 2.0 SINGULAR_ ATTRIBUTE Single-valued attribute type

to the embeddable class or basic type are derived from the attributes of the embeddable class or ... annotation is used on the collection-valued attribute in addition to the ElementCollection annotation ... Annotation Attributes String catalog default "" (Optional) The catalog of the table. If not specified

JPA Method in javax.persistence.Subgraph void addAttributeNodes (   String... attributeName ) Add one or more attribute nodes to the entity graph. Parameters: attributeName - name of the attribute Throws: IllegalArgumentException - if the attribute is not an attribute

JPA Annotation Attribute in javax.persistence.NamedSubgraph NamedAttributeNode [] attributeNodes default null (Required) The list of the attributes of the class that must be included. If the named subgraph corresponds to a subclass of the class referenced by the corresponding attribute node, then only subclass-specific attributes are listed. Since: JPA 2.1