net.sourceforge.ccxjc.it.model.pub.indexed.novalueclass.persistence.orm
Interface EntityMappings

All Known Implementing Classes:

EntityMappingsImpl

public interface EntityMappings

The entity-mappings element is the root element of an 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 or named-native-query 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="1.0" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

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.
Embeddable[]	getEmbeddable()
Embeddable	getEmbeddable(int idx)
int	getEmbeddableLength()
Entity[]	getEntity()
Entity	getEntity(int idx)
int	getEntityLength()
MappedSuperclass[]	getMappedSuperclass()
MappedSuperclass	getMappedSuperclass(int idx)
int	getMappedSuperclassLength()
NamedNativeQuery[]	getNamedNativeQuery()
NamedNativeQuery	getNamedNativeQuery(int idx)
int	getNamedNativeQueryLength()
NamedQuery[]	getNamedQuery()
NamedQuery	getNamedQuery(int idx)
int	getNamedQueryLength()
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.
SequenceGenerator[]	getSequenceGenerator()
SequenceGenerator	getSequenceGenerator(int idx)
int	getSequenceGeneratorLength()
SqlResultSetMapping[]	getSqlResultSetMapping()
SqlResultSetMapping	getSqlResultSetMapping(int idx)
int	getSqlResultSetMappingLength()
TableGenerator[]	getTableGenerator()
TableGenerator	getTableGenerator(int idx)
int	getTableGeneratorLength()
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	setEmbeddable(Embeddable[] values)
Embeddable	setEmbeddable(int idx, Embeddable value)
void	setEntity(Entity[] values)
Entity	setEntity(int idx, Entity value)
MappedSuperclass	setMappedSuperclass(int idx, MappedSuperclass value)
void	setMappedSuperclass(MappedSuperclass[] values)
NamedNativeQuery	setNamedNativeQuery(int idx, NamedNativeQuery value)
void	setNamedNativeQuery(NamedNativeQuery[] values)
NamedQuery	setNamedQuery(int idx, NamedQuery value)
void	setNamedQuery(NamedQuery[] values)
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.
SequenceGenerator	setSequenceGenerator(int idx, SequenceGenerator value)
void	setSequenceGenerator(SequenceGenerator[] values)
SqlResultSetMapping	setSqlResultSetMapping(int idx, SqlResultSetMapping value)
void	setSqlResultSetMapping(SqlResultSetMapping[] values)
TableGenerator	setTableGenerator(int idx, TableGenerator value)
void	setTableGenerator(TableGenerator[] values)
void	setVersion(String value) Sets the value of the version property.

Method Detail

getDescription

String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getPersistenceUnitMetadata

PersistenceUnitMetadata getPersistenceUnitMetadata()

Gets the value of the persistenceUnitMetadata property.

Returns:

possible object is PersistenceUnitMetadata

setPersistenceUnitMetadata

void setPersistenceUnitMetadata(PersistenceUnitMetadata value)

Sets the value of the persistenceUnitMetadata property.

Parameters:

value - allowed object is PersistenceUnitMetadata

getPackage

String getPackage()

Gets the value of the package property.

Returns:

possible object is String

setPackage

void setPackage(String value)

Sets the value of the package property.

Parameters:

value - allowed object is String

getSchema

String getSchema()

Gets the value of the schema property.

Returns:

possible object is String

setSchema

void setSchema(String value)

Sets the value of the schema property.

Parameters:

value - allowed object is String

getCatalog

String getCatalog()

Gets the value of the catalog property.

Returns:

possible object is String

setCatalog

void setCatalog(String value)

Sets the value of the catalog property.

Parameters:

value - allowed object is String

getAccess

AccessType getAccess()

Gets the value of the access property.

Returns:

possible object is AccessType

setAccess

void setAccess(AccessType value)

Sets the value of the access property.

Parameters:

value - allowed object is AccessType

getSequenceGenerator

SequenceGenerator[] getSequenceGenerator()

Returns:

array of SequenceGenerator

getSequenceGenerator

SequenceGenerator getSequenceGenerator(int idx)

Returns:

one of SequenceGenerator

getSequenceGeneratorLength

int getSequenceGeneratorLength()

setSequenceGenerator

void setSequenceGenerator(SequenceGenerator[] values)

Parameters:

values - allowed objects are SequenceGenerator

setSequenceGenerator

SequenceGenerator setSequenceGenerator(int idx,
                                       SequenceGenerator value)

Parameters:

value - allowed object is SequenceGenerator

getTableGenerator

TableGenerator[] getTableGenerator()

Returns:

array of TableGenerator

getTableGenerator

TableGenerator getTableGenerator(int idx)

Returns:

one of TableGenerator

getTableGeneratorLength

int getTableGeneratorLength()

setTableGenerator

void setTableGenerator(TableGenerator[] values)

Parameters:

values - allowed objects are TableGenerator

setTableGenerator

TableGenerator setTableGenerator(int idx,
                                 TableGenerator value)

Parameters:

value - allowed object is TableGenerator

getNamedQuery

NamedQuery[] getNamedQuery()

Returns:

array of NamedQuery

getNamedQuery

NamedQuery getNamedQuery(int idx)

Returns:

one of NamedQuery

getNamedQueryLength

int getNamedQueryLength()

setNamedQuery

void setNamedQuery(NamedQuery[] values)

Parameters:

values - allowed objects are NamedQuery

setNamedQuery

NamedQuery setNamedQuery(int idx,
                         NamedQuery value)

Parameters:

value - allowed object is NamedQuery

getNamedNativeQuery

NamedNativeQuery[] getNamedNativeQuery()

Returns:

array of NamedNativeQuery

getNamedNativeQuery

NamedNativeQuery getNamedNativeQuery(int idx)

Returns:

one of NamedNativeQuery

getNamedNativeQueryLength

int getNamedNativeQueryLength()

setNamedNativeQuery

void setNamedNativeQuery(NamedNativeQuery[] values)

Parameters:

values - allowed objects are NamedNativeQuery

setNamedNativeQuery

NamedNativeQuery setNamedNativeQuery(int idx,
                                     NamedNativeQuery value)

Parameters:

value - allowed object is NamedNativeQuery

getSqlResultSetMapping

SqlResultSetMapping[] getSqlResultSetMapping()

Returns:

array of SqlResultSetMapping

getSqlResultSetMapping

SqlResultSetMapping getSqlResultSetMapping(int idx)

Returns:

one of SqlResultSetMapping

getSqlResultSetMappingLength

int getSqlResultSetMappingLength()

setSqlResultSetMapping

void setSqlResultSetMapping(SqlResultSetMapping[] values)

Parameters:

values - allowed objects are SqlResultSetMapping

setSqlResultSetMapping

SqlResultSetMapping setSqlResultSetMapping(int idx,
                                           SqlResultSetMapping value)

Parameters:

value - allowed object is SqlResultSetMapping

getMappedSuperclass

MappedSuperclass[] getMappedSuperclass()

Returns:

array of MappedSuperclass

getMappedSuperclass

MappedSuperclass getMappedSuperclass(int idx)

Returns:

one of MappedSuperclass

getMappedSuperclassLength

int getMappedSuperclassLength()

setMappedSuperclass

void setMappedSuperclass(MappedSuperclass[] values)

Parameters:

values - allowed objects are MappedSuperclass

setMappedSuperclass

MappedSuperclass setMappedSuperclass(int idx,
                                     MappedSuperclass value)

Parameters:

value - allowed object is MappedSuperclass

getEntity

Entity[] getEntity()

Returns:

array of Entity

getEntity

Entity getEntity(int idx)

Returns:

one of Entity

getEntityLength

int getEntityLength()

setEntity

void setEntity(Entity[] values)

Parameters:

values - allowed objects are Entity

setEntity

Entity setEntity(int idx,
                 Entity value)

Parameters:

value - allowed object is Entity

getEmbeddable

Embeddable[] getEmbeddable()

Returns:

array of Embeddable

getEmbeddable

Embeddable getEmbeddable(int idx)

Returns:

one of Embeddable

getEmbeddableLength

int getEmbeddableLength()

setEmbeddable

void setEmbeddable(Embeddable[] values)

Parameters:

values - allowed objects are Embeddable

setEmbeddable

Embeddable setEmbeddable(int idx,
                         Embeddable value)

Parameters:

value - allowed object is Embeddable

getVersion

String getVersion()

Gets the value of the version property.

Returns:

possible object is String

setVersion

void setVersion(String value)

Sets the value of the version property.

Parameters:

value - allowed object is String