public interface OrmDescriptor extends Descriptor, DescriptorNamespace<OrmDescriptor>, OrmCommonDescriptor<OrmDescriptor,PersistenceUnitMetadata<OrmDescriptor>,SequenceGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedNativeQuery<OrmDescriptor>,SqlResultSetMapping<OrmDescriptor>,Embeddable<OrmDescriptor>>
This deployment descriptor provides the functionalities as described in the specification
Example:
OrmDescriptor descriptor = Descriptors.create(OrmDescriptor.class);
Modifier and Type | Method and Description |
---|---|
OrmDescriptor |
_package(String _package)
Sets the
package element |
OrmDescriptor |
access(AccessType access)
Sets the
access element |
OrmDescriptor |
access(String access)
Sets the
access element |
OrmDescriptor |
catalog(String catalog)
Sets the
catalog element |
Converter<OrmDescriptor> |
createConverter()
Creates a new
converter element |
Embeddable<OrmDescriptor> |
createEmbeddable()
Creates a new
embeddable element |
Entity<OrmDescriptor> |
createEntity()
Creates a new
entity element |
MappedSuperclass<OrmDescriptor> |
createMappedSuperclass()
Creates a new
mapped-superclass element |
NamedNativeQuery<OrmDescriptor> |
createNamedNativeQuery()
Creates a new
named-native-query element |
NamedQuery<OrmDescriptor> |
createNamedQuery()
Creates a new
named-query element |
NamedStoredProcedureQuery<OrmDescriptor> |
createNamedStoredProcedureQuery()
Creates a new
named-stored-procedure-query element |
SequenceGenerator<OrmDescriptor> |
createSequenceGenerator()
Creates a new
sequence-generator element |
SqlResultSetMapping<OrmDescriptor> |
createSqlResultSetMapping()
Creates a new
sql-result-set-mapping element |
TableGenerator<OrmDescriptor> |
createTableGenerator()
Creates a new
table-generator element |
OrmDescriptor |
description(String description)
Sets the
description element |
AccessType |
getAccess()
Returns the
access element |
String |
getAccessAsString()
Returns the
access element |
List<Converter<OrmDescriptor>> |
getAllConverter()
Returns all
converter elements |
List<Embeddable<OrmDescriptor>> |
getAllEmbeddable()
Returns all
embeddable elements |
List<Entity<OrmDescriptor>> |
getAllEntity()
Returns all
entity elements |
List<MappedSuperclass<OrmDescriptor>> |
getAllMappedSuperclass()
Returns all
mapped-superclass elements |
List<NamedNativeQuery<OrmDescriptor>> |
getAllNamedNativeQuery()
Returns all
named-native-query elements |
List<NamedQuery<OrmDescriptor>> |
getAllNamedQuery()
Returns all
named-query elements |
List<NamedStoredProcedureQuery<OrmDescriptor>> |
getAllNamedStoredProcedureQuery()
Returns all
named-stored-procedure-query elements |
List<SequenceGenerator<OrmDescriptor>> |
getAllSequenceGenerator()
Returns all
sequence-generator elements |
List<SqlResultSetMapping<OrmDescriptor>> |
getAllSqlResultSetMapping()
Returns all
sql-result-set-mapping elements |
List<TableGenerator<OrmDescriptor>> |
getAllTableGenerator()
Returns all
table-generator elements |
String |
getCatalog()
Returns the
catalog element |
String |
getDescription()
Returns the
description element |
Converter<OrmDescriptor> |
getOrCreateConverter()
If not already created, a new
converter element will be created and returned. |
Embeddable<OrmDescriptor> |
getOrCreateEmbeddable()
If not already created, a new
embeddable element will be created and returned. |
Entity<OrmDescriptor> |
getOrCreateEntity()
If not already created, a new
entity element will be created and returned. |
MappedSuperclass<OrmDescriptor> |
getOrCreateMappedSuperclass()
If not already created, a new
mapped-superclass element will be created and returned. |
NamedNativeQuery<OrmDescriptor> |
getOrCreateNamedNativeQuery()
If not already created, a new
named-native-query element will be created and returned. |
NamedQuery<OrmDescriptor> |
getOrCreateNamedQuery()
If not already created, a new
named-query element will be created and returned. |
NamedStoredProcedureQuery<OrmDescriptor> |
getOrCreateNamedStoredProcedureQuery()
If not already created, a new
named-stored-procedure-query element will be created and returned. |
PersistenceUnitMetadata<OrmDescriptor> |
getOrCreatePersistenceUnitMetadata()
If not already created, a new
persistence-unit-metadata element with the given value will be created. |
SequenceGenerator<OrmDescriptor> |
getOrCreateSequenceGenerator()
If not already created, a new
sequence-generator element will be created and returned. |
SqlResultSetMapping<OrmDescriptor> |
getOrCreateSqlResultSetMapping()
If not already created, a new
sql-result-set-mapping element will be created and returned. |
TableGenerator<OrmDescriptor> |
getOrCreateTableGenerator()
If not already created, a new
table-generator element will be created and returned. |
String |
getPackage()
Returns the
package element |
String |
getSchema()
Returns the
schema element |
String |
getVersion()
Returns the
version attribute |
OrmDescriptor |
removeAccess()
Removes the
access attribute |
OrmDescriptor |
removeAllConverter()
Removes all
converter elements |
OrmDescriptor |
removeAllEmbeddable()
Removes all
embeddable elements |
OrmDescriptor |
removeAllEntity()
Removes all
entity elements |
OrmDescriptor |
removeAllMappedSuperclass()
Removes all
mapped-superclass elements |
OrmDescriptor |
removeAllNamedNativeQuery()
Removes all
named-native-query elements |
OrmDescriptor |
removeAllNamedQuery()
Removes all
named-query elements |
OrmDescriptor |
removeAllNamedStoredProcedureQuery()
Removes all
named-stored-procedure-query elements |
OrmDescriptor |
removeAllSequenceGenerator()
Removes all
sequence-generator elements |
OrmDescriptor |
removeAllSqlResultSetMapping()
Removes all
sql-result-set-mapping elements |
OrmDescriptor |
removeAllTableGenerator()
Removes all
table-generator elements |
OrmDescriptor |
removeCatalog()
Removes the
catalog element |
OrmDescriptor |
removeDescription()
Removes the
description element |
OrmDescriptor |
removePackage()
Removes the
package element |
OrmDescriptor |
removePersistenceUnitMetadata()
Removes the
persistence-unit-metadata element |
OrmDescriptor |
removeSchema()
Removes the
schema element |
OrmDescriptor |
removeVersion()
Removes the
version attribute |
OrmDescriptor |
schema(String schema)
Sets the
schema element |
OrmDescriptor |
version(String version)
Sets the
version attribute |
addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces
exportAsString, exportTo, getDescriptorName
static final String VERSION
OrmDescriptor description(String description)
description
elementdescription
- the value for the element description
OrmDescriptor
String getDescription()
description
elementdescription
OrmDescriptor removeDescription()
description
elementOrmDescriptor
PersistenceUnitMetadata<OrmDescriptor> getOrCreatePersistenceUnitMetadata()
persistence-unit-metadata
element with the given value will be created.
Otherwise, the existing persistence-unit-metadata
element will be returned.PersistenceUnitMetadata
OrmDescriptor removePersistenceUnitMetadata()
persistence-unit-metadata
elementOrmDescriptor
OrmDescriptor _package(String _package)
package
element_package
- the value for the element package
OrmDescriptor
String getPackage()
package
elementpackage
OrmDescriptor removePackage()
package
elementOrmDescriptor
OrmDescriptor schema(String schema)
schema
elementschema
- the value for the element schema
OrmDescriptor
String getSchema()
schema
elementschema
OrmDescriptor removeSchema()
schema
elementOrmDescriptor
OrmDescriptor catalog(String catalog)
catalog
elementcatalog
- the value for the element catalog
OrmDescriptor
String getCatalog()
catalog
elementcatalog
OrmDescriptor removeCatalog()
catalog
elementOrmDescriptor
OrmDescriptor access(AccessType access)
access
elementaccess
- the value for the element access
OrmDescriptor
OrmDescriptor access(String access)
access
elementaccess
- the value for the element access
OrmDescriptor
AccessType getAccess()
access
elementaccess
String getAccessAsString()
access
elementaccess
OrmDescriptor removeAccess()
access
attributeOrmDescriptor
SequenceGenerator<OrmDescriptor> getOrCreateSequenceGenerator()
sequence-generator
element will be created and returned.
Otherwise, the first existing sequence-generator
element will be returned.sequence-generator
SequenceGenerator<OrmDescriptor> createSequenceGenerator()
sequence-generator
elementSequenceGenerator
List<SequenceGenerator<OrmDescriptor>> getAllSequenceGenerator()
sequence-generator
elementssequence-generator
OrmDescriptor removeAllSequenceGenerator()
sequence-generator
elementsSequenceGenerator
TableGenerator<OrmDescriptor> getOrCreateTableGenerator()
table-generator
element will be created and returned.
Otherwise, the first existing table-generator
element will be returned.table-generator
TableGenerator<OrmDescriptor> createTableGenerator()
table-generator
elementTableGenerator
List<TableGenerator<OrmDescriptor>> getAllTableGenerator()
table-generator
elementstable-generator
OrmDescriptor removeAllTableGenerator()
table-generator
elementsTableGenerator
NamedQuery<OrmDescriptor> getOrCreateNamedQuery()
named-query
element will be created and returned.
Otherwise, the first existing named-query
element will be returned.named-query
NamedQuery<OrmDescriptor> createNamedQuery()
named-query
elementNamedQuery
List<NamedQuery<OrmDescriptor>> getAllNamedQuery()
named-query
elementsnamed-query
OrmDescriptor removeAllNamedQuery()
named-query
elementsNamedQuery
NamedNativeQuery<OrmDescriptor> getOrCreateNamedNativeQuery()
named-native-query
element will be created and returned.
Otherwise, the first existing named-native-query
element will be returned.named-native-query
NamedNativeQuery<OrmDescriptor> createNamedNativeQuery()
named-native-query
elementNamedNativeQuery
List<NamedNativeQuery<OrmDescriptor>> getAllNamedNativeQuery()
named-native-query
elementsnamed-native-query
OrmDescriptor removeAllNamedNativeQuery()
named-native-query
elementsNamedNativeQuery
NamedStoredProcedureQuery<OrmDescriptor> getOrCreateNamedStoredProcedureQuery()
named-stored-procedure-query
element will be created and returned.
Otherwise, the first existing named-stored-procedure-query
element will be returned.named-stored-procedure-query
NamedStoredProcedureQuery<OrmDescriptor> createNamedStoredProcedureQuery()
named-stored-procedure-query
elementNamedStoredProcedureQuery
List<NamedStoredProcedureQuery<OrmDescriptor>> getAllNamedStoredProcedureQuery()
named-stored-procedure-query
elementsnamed-stored-procedure-query
OrmDescriptor removeAllNamedStoredProcedureQuery()
named-stored-procedure-query
elementsNamedStoredProcedureQuery
SqlResultSetMapping<OrmDescriptor> getOrCreateSqlResultSetMapping()
sql-result-set-mapping
element will be created and returned.
Otherwise, the first existing sql-result-set-mapping
element will be returned.sql-result-set-mapping
SqlResultSetMapping<OrmDescriptor> createSqlResultSetMapping()
sql-result-set-mapping
elementSqlResultSetMapping
List<SqlResultSetMapping<OrmDescriptor>> getAllSqlResultSetMapping()
sql-result-set-mapping
elementssql-result-set-mapping
OrmDescriptor removeAllSqlResultSetMapping()
sql-result-set-mapping
elementsSqlResultSetMapping
MappedSuperclass<OrmDescriptor> getOrCreateMappedSuperclass()
mapped-superclass
element will be created and returned.
Otherwise, the first existing mapped-superclass
element will be returned.mapped-superclass
MappedSuperclass<OrmDescriptor> createMappedSuperclass()
mapped-superclass
elementMappedSuperclass
List<MappedSuperclass<OrmDescriptor>> getAllMappedSuperclass()
mapped-superclass
elementsmapped-superclass
OrmDescriptor removeAllMappedSuperclass()
mapped-superclass
elementsMappedSuperclass
Entity<OrmDescriptor> getOrCreateEntity()
entity
element will be created and returned.
Otherwise, the first existing entity
element will be returned.entity
Entity<OrmDescriptor> createEntity()
entity
elementEntity
List<Entity<OrmDescriptor>> getAllEntity()
entity
elementsentity
OrmDescriptor removeAllEntity()
entity
elementsEntity
Embeddable<OrmDescriptor> getOrCreateEmbeddable()
embeddable
element will be created and returned.
Otherwise, the first existing embeddable
element will be returned.embeddable
Embeddable<OrmDescriptor> createEmbeddable()
embeddable
elementEmbeddable
List<Embeddable<OrmDescriptor>> getAllEmbeddable()
embeddable
elementsembeddable
OrmDescriptor removeAllEmbeddable()
embeddable
elementsEmbeddable
Converter<OrmDescriptor> getOrCreateConverter()
converter
element will be created and returned.
Otherwise, the first existing converter
element will be returned.converter
Converter<OrmDescriptor> createConverter()
converter
elementConverter
List<Converter<OrmDescriptor>> getAllConverter()
converter
elementsconverter
OrmDescriptor removeAllConverter()
converter
elementsConverter
OrmDescriptor version(String version)
version
attributeversion
in interface OrmCommonDescriptor<OrmDescriptor,PersistenceUnitMetadata<OrmDescriptor>,SequenceGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedNativeQuery<OrmDescriptor>,SqlResultSetMapping<OrmDescriptor>,Embeddable<OrmDescriptor>>
version
- the value for the attribute version
OrmDescriptor
String getVersion()
version
attributegetVersion
in interface OrmCommonDescriptor<OrmDescriptor,PersistenceUnitMetadata<OrmDescriptor>,SequenceGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedNativeQuery<OrmDescriptor>,SqlResultSetMapping<OrmDescriptor>,Embeddable<OrmDescriptor>>
version
OrmDescriptor removeVersion()
version
attributeremoveVersion
in interface OrmCommonDescriptor<OrmDescriptor,PersistenceUnitMetadata<OrmDescriptor>,SequenceGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,TableGenerator<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedQuery<OrmDescriptor>,NamedNativeQuery<OrmDescriptor>,SqlResultSetMapping<OrmDescriptor>,Embeddable<OrmDescriptor>>
OrmDescriptor
Copyright © 2016 JBoss by Red Hat. All rights reserved.