org.apache.openejb.jee.jpa

Class EntityMappings

java.lang.Object

org.apache.openejb.jee.jpa.EntityMappings

public class EntityMappings
extends Object

The entity-mappings element is the root element of a mapping file. It contains the following four types of elements:

1. The persistence-unit-metadata element contains metadata for the entire persistence unit. It is undefined if this element occurs in multiple mapping files within the same persistence unit.

2. The package, schema, catalog and access elements apply to all of the entity, mapped-superclass and embeddable elements defined in the same file in which they occur.

3. The sequence-generator, table-generator, named-query, named-native-query and sql-result-set-mapping elements are global to the persistence unit. It is undefined to have more than one sequence-generator or table-generator of the same name in the same or different mapping files in a persistence unit. It is also undefined to have more than one named-query, named-native-query, or result-set-mapping of the same name in the same or different mapping files in a persistence unit.

4. The entity, mapped-superclass and embeddable elements each define the mapping information for a managed persistent class. The mapping information contained in these elements may be complete or it may be partial.

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="persistence-unit-metadata" type="{http://java.sun.com/xml/ns/persistence/orm}persistence-unit-metadata" minOccurs="0"/>
         <element name="package" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="schema" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="catalog" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="access" type="{http://java.sun.com/xml/ns/persistence/orm}access-type" minOccurs="0"/>
         <element name="sequence-generator" type="{http://java.sun.com/xml/ns/persistence/orm}sequence-generator" maxOccurs="unbounded" minOccurs="0"/>
         <element name="table-generator" type="{http://java.sun.com/xml/ns/persistence/orm}table-generator" maxOccurs="unbounded" minOccurs="0"/>
         <element name="named-query" type="{http://java.sun.com/xml/ns/persistence/orm}named-query" maxOccurs="unbounded" minOccurs="0"/>
         <element name="named-native-query" type="{http://java.sun.com/xml/ns/persistence/orm}named-native-query" maxOccurs="unbounded" minOccurs="0"/>
         <element name="sql-result-set-mapping" type="{http://java.sun.com/xml/ns/persistence/orm}sql-result-set-mapping" maxOccurs="unbounded" minOccurs="0"/>
         <element name="mapped-superclass" type="{http://java.sun.com/xml/ns/persistence/orm}mapped-superclass" maxOccurs="unbounded" minOccurs="0"/>
         <element name="entity" type="{http://java.sun.com/xml/ns/persistence/orm}entity" maxOccurs="unbounded" minOccurs="0"/>
         <element name="embeddable" type="{http://java.sun.com/xml/ns/persistence/orm}embeddable" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="version" use="required" type="{http://java.sun.com/xml/ns/persistence/orm}versionType" fixed="2.0" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_package
protected AccessType	access
protected String	catalog
protected String	description
protected List<Embeddable>	embeddable
protected KeyedCollection<String,Entity>	entity
protected KeyedCollection<String,MappedSuperclass>	mappedSuperclass
protected List<NamedNativeQuery>	namedNativeQuery
protected List<NamedQuery>	namedQuery
protected PersistenceUnitMetadata	persistenceUnitMetadata
protected String	schema
protected List<SequenceGenerator>	sequenceGenerator
protected List<SqlResultSetMapping>	sqlResultSetMapping
protected List<TableGenerator>	tableGenerator
protected String	version

Constructor Summary

Constructors

Constructor and Description
EntityMappings()

Method Summary

Methods

Modifier and Type	Method and Description
AccessType	getAccess() Gets the value of the access property.
String	getCatalog() Gets the value of the catalog property.
String	getDescription() Gets the value of the description property.
List<Embeddable>	getEmbeddable() Gets the value of the embeddable property.
Collection<Entity>	getEntity() Gets the value of the entity property.
Map<String,Entity>	getEntityMap()
Collection<MappedSuperclass>	getMappedSuperclass() Gets the value of the mappedSuperclass property.
Map<String,MappedSuperclass>	getMappedSuperclassMap()
List<NamedNativeQuery>	getNamedNativeQuery() Gets the value of the namedNativeQuery property.
List<NamedQuery>	getNamedQuery() Gets the value of the namedQuery property.
String	getPackage() Gets the value of the package property.
PersistenceUnitMetadata	getPersistenceUnitMetadata() Gets the value of the persistenceUnitMetadata property.
String	getSchema() Gets the value of the schema property.
List<SequenceGenerator>	getSequenceGenerator() Gets the value of the sequenceGenerator property.
List<SqlResultSetMapping>	getSqlResultSetMapping() Gets the value of the sqlResultSetMapping property.
List<TableGenerator>	getTableGenerator() Gets the value of the tableGenerator property.
String	getVersion() Gets the value of the version property.
void	setAccess(AccessType value) Sets the value of the access property.
void	setCatalog(String value) Sets the value of the catalog property.
void	setDescription(String value) Sets the value of the description property.
void	setPackage(String value) Sets the value of the package property.
void	setPersistenceUnitMetadata(PersistenceUnitMetadata value) Sets the value of the persistenceUnitMetadata property.
void	setSchema(String value) Sets the value of the schema property.
void	setVersion(String value) Sets the value of the version property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected String description

persistenceUnitMetadata

protected PersistenceUnitMetadata persistenceUnitMetadata

_package

protected String _package

schema

protected String schema

catalog

protected String catalog

access

protected AccessType access

sequenceGenerator

protected List<SequenceGenerator> sequenceGenerator

tableGenerator

protected List<TableGenerator> tableGenerator

namedQuery

protected List<NamedQuery> namedQuery

namedNativeQuery

protected List<NamedNativeQuery> namedNativeQuery

sqlResultSetMapping

protected List<SqlResultSetMapping> sqlResultSetMapping

mappedSuperclass

protected KeyedCollection<String,MappedSuperclass> mappedSuperclass

entity

protected KeyedCollection<String,Entity> entity

embeddable

protected List<Embeddable> embeddable

version

protected String version

Constructor Detail

EntityMappings

public EntityMappings()

Method Detail

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getPersistenceUnitMetadata

public PersistenceUnitMetadata getPersistenceUnitMetadata()

Gets the value of the persistenceUnitMetadata property.

Returns:

possible object is PersistenceUnitMetadata

setPersistenceUnitMetadata

public void setPersistenceUnitMetadata(PersistenceUnitMetadata value)

Sets the value of the persistenceUnitMetadata property.

Parameters:

value - allowed object is PersistenceUnitMetadata

getPackage

public String getPackage()

Gets the value of the package property.

Returns:

possible object is String

setPackage

public void setPackage(String value)

Sets the value of the package property.

Parameters:

value - allowed object is String

getSchema

public String getSchema()

Gets the value of the schema property.

Returns:

possible object is String

setSchema

public void setSchema(String value)

Sets the value of the schema property.

Parameters:

value - allowed object is String

getCatalog

public String getCatalog()

Gets the value of the catalog property.

Returns:

possible object is String

setCatalog

public void setCatalog(String value)

Sets the value of the catalog property.

Parameters:

value - allowed object is String

getAccess

public AccessType getAccess()

Gets the value of the access property.

Returns:

possible object is AccessType

setAccess

public void setAccess(AccessType value)

Sets the value of the access property.

Parameters:

value - allowed object is AccessType

getSequenceGenerator

public List<SequenceGenerator> getSequenceGenerator()

Gets the value of the sequenceGenerator property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the sequenceGenerator property.

For example, to add a new item, do as follows:

    getSequenceGenerator().add(newItem);
 

Objects of the following type(s) are allowed in the list SequenceGenerator

getTableGenerator

public List<TableGenerator> getTableGenerator()

Gets the value of the tableGenerator property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the tableGenerator property.

For example, to add a new item, do as follows:

    getTableGenerator().add(newItem);
 

Objects of the following type(s) are allowed in the list TableGenerator

getNamedQuery

public List<NamedQuery> getNamedQuery()

Gets the value of the namedQuery property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the namedQuery property.

For example, to add a new item, do as follows:

    getNamedQuery().add(newItem);
 

Objects of the following type(s) are allowed in the list NamedQuery

getNamedNativeQuery

public List<NamedNativeQuery> getNamedNativeQuery()

Gets the value of the namedNativeQuery property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the namedNativeQuery property.

For example, to add a new item, do as follows:

    getNamedNativeQuery().add(newItem);
 

Objects of the following type(s) are allowed in the list NamedNativeQuery

getSqlResultSetMapping

public List<SqlResultSetMapping> getSqlResultSetMapping()

Gets the value of the sqlResultSetMapping property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the sqlResultSetMapping property.

For example, to add a new item, do as follows:

    getSqlResultSetMapping().add(newItem);
 

Objects of the following type(s) are allowed in the list SqlResultSetMapping

getMappedSuperclass

public Collection<MappedSuperclass> getMappedSuperclass()

Gets the value of the mappedSuperclass property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the mappedSuperclass property.

For example, to add a new item, do as follows:

    getMappedSuperclass().add(newItem);
 

Objects of the following type(s) are allowed in the list MappedSuperclass

getMappedSuperclassMap

public Map<String,MappedSuperclass> getMappedSuperclassMap()

getEntity

public Collection<Entity> getEntity()

Gets the value of the entity property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the entity property.

For example, to add a new item, do as follows:

    getEntity().add(newItem);
 

Objects of the following type(s) are allowed in the list Entity

getEntityMap

public Map<String,Entity> getEntityMap()

getEmbeddable

public List<Embeddable> getEmbeddable()

Gets the value of the embeddable property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the embeddable property.

For example, to add a new item, do as follows:

    getEmbeddable().add(newItem);
 

Objects of the following type(s) are allowed in the list Embeddable

getVersion

public String getVersion()

Gets the value of the version property.

Returns:

possible object is String

setVersion

public void setVersion(String value)

Sets the value of the version property.

Parameters:

value - allowed object is String