org.jboss.shrinkwrap.descriptor.api.orm20
Interface OrmDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<OrmDescriptor>

public interface OrmDescriptor
extends Descriptor, DescriptorNamespace<OrmDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

OrmDescriptor descriptor = Descriptors.create(OrmDescriptor.class);

Since:

Generation date :2012-05-09T23:45:05.33-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

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
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
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<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<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
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.
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	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	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

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor

exportAsString, exportTo, getDescriptorName

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Method Detail

description

OrmDescriptor description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of OrmDescriptor

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

OrmDescriptor removeDescription()

Removes the description element

Returns:

the current instance of OrmDescriptor

getOrCreatePersistenceUnitMetadata

PersistenceUnitMetadata<OrmDescriptor> getOrCreatePersistenceUnitMetadata()

If not already created, a new persistence-unit-metadata element with the given value will be created. Otherwise, the existing persistence-unit-metadata element will be returned.

Returns:

a new or existing instance of PersistenceUnitMetadata

removePersistenceUnitMetadata

OrmDescriptor removePersistenceUnitMetadata()

Removes the persistence-unit-metadata element

Returns:

the current instance of OrmDescriptor

_package

OrmDescriptor _package(String _package)

Sets the package element

Parameters:

_package - the value for the element package

Returns:

the current instance of OrmDescriptor

getPackage

String getPackage()

Returns the package element

Returns:

the node defined for the element package

removePackage

OrmDescriptor removePackage()

Removes the package element

Returns:

the current instance of OrmDescriptor

schema

OrmDescriptor schema(String schema)

Sets the schema element

Parameters:

schema - the value for the element schema

Returns:

the current instance of OrmDescriptor

getSchema

String getSchema()

Returns the schema element

Returns:

the node defined for the element schema

removeSchema

OrmDescriptor removeSchema()

Removes the schema element

Returns:

the current instance of OrmDescriptor

catalog

OrmDescriptor catalog(String catalog)

Sets the catalog element

Parameters:

catalog - the value for the element catalog

Returns:

the current instance of OrmDescriptor

getCatalog

String getCatalog()

Returns the catalog element

Returns:

the node defined for the element catalog

removeCatalog

OrmDescriptor removeCatalog()

Removes the catalog element

Returns:

the current instance of OrmDescriptor

access

OrmDescriptor access(AccessType access)

Sets the access element

Parameters:

access - the value for the element access

Returns:

the current instance of OrmDescriptor

access

OrmDescriptor access(String access)

Sets the access element

Parameters:

access - the value for the element access

Returns:

the current instance of OrmDescriptor

getAccess

AccessType getAccess()

Returns the access element

Returns:

the value found for the element access

getAccessAsString

String getAccessAsString()

Returns the access element

Returns:

the value found for the element access

removeAccess

OrmDescriptor removeAccess()

Removes the access attribute

Returns:

the current instance of OrmDescriptor

getOrCreateSequenceGenerator

SequenceGenerator<OrmDescriptor> getOrCreateSequenceGenerator()

If not already created, a new sequence-generator element will be created and returned. Otherwise, the first existing sequence-generator element will be returned.

Returns:

the instance defined for the element sequence-generator

createSequenceGenerator

SequenceGenerator<OrmDescriptor> createSequenceGenerator()

Creates a new sequence-generator element

Returns:

the new created instance of SequenceGenerator

getAllSequenceGenerator

List<SequenceGenerator<OrmDescriptor>> getAllSequenceGenerator()

Returns all sequence-generator elements

Returns:

list of sequence-generator

removeAllSequenceGenerator

OrmDescriptor removeAllSequenceGenerator()

Removes all sequence-generator elements

Returns:

the current instance of SequenceGenerator

getOrCreateTableGenerator

TableGenerator<OrmDescriptor> getOrCreateTableGenerator()

If not already created, a new table-generator element will be created and returned. Otherwise, the first existing table-generator element will be returned.

Returns:

the instance defined for the element table-generator

createTableGenerator

TableGenerator<OrmDescriptor> createTableGenerator()

Creates a new table-generator element

Returns:

the new created instance of TableGenerator

getAllTableGenerator

List<TableGenerator<OrmDescriptor>> getAllTableGenerator()

Returns all table-generator elements

Returns:

list of table-generator

removeAllTableGenerator

OrmDescriptor removeAllTableGenerator()

Removes all table-generator elements

Returns:

the current instance of TableGenerator

getOrCreateNamedQuery

NamedQuery<OrmDescriptor> getOrCreateNamedQuery()

If not already created, a new named-query element will be created and returned. Otherwise, the first existing named-query element will be returned.

Returns:

the instance defined for the element named-query

createNamedQuery

NamedQuery<OrmDescriptor> createNamedQuery()

Creates a new named-query element

Returns:

the new created instance of NamedQuery

getAllNamedQuery

List<NamedQuery<OrmDescriptor>> getAllNamedQuery()

Returns all named-query elements

Returns:

list of named-query

removeAllNamedQuery

OrmDescriptor removeAllNamedQuery()

Removes all named-query elements

Returns:

the current instance of NamedQuery

getOrCreateNamedNativeQuery

NamedNativeQuery<OrmDescriptor> getOrCreateNamedNativeQuery()

If not already created, a new named-native-query element will be created and returned. Otherwise, the first existing named-native-query element will be returned.

Returns:

the instance defined for the element named-native-query

createNamedNativeQuery

NamedNativeQuery<OrmDescriptor> createNamedNativeQuery()

Creates a new named-native-query element

Returns:

the new created instance of NamedNativeQuery

getAllNamedNativeQuery

List<NamedNativeQuery<OrmDescriptor>> getAllNamedNativeQuery()

Returns all named-native-query elements

Returns:

list of named-native-query

removeAllNamedNativeQuery

OrmDescriptor removeAllNamedNativeQuery()

Removes all named-native-query elements

Returns:

the current instance of NamedNativeQuery

getOrCreateSqlResultSetMapping

SqlResultSetMapping<OrmDescriptor> getOrCreateSqlResultSetMapping()

If not already created, a new sql-result-set-mapping element will be created and returned. Otherwise, the first existing sql-result-set-mapping element will be returned.

Returns:

the instance defined for the element sql-result-set-mapping

createSqlResultSetMapping

SqlResultSetMapping<OrmDescriptor> createSqlResultSetMapping()

Creates a new sql-result-set-mapping element

Returns:

the new created instance of SqlResultSetMapping

getAllSqlResultSetMapping

List<SqlResultSetMapping<OrmDescriptor>> getAllSqlResultSetMapping()

Returns all sql-result-set-mapping elements

Returns:

list of sql-result-set-mapping

removeAllSqlResultSetMapping

OrmDescriptor removeAllSqlResultSetMapping()

Removes all sql-result-set-mapping elements

Returns:

the current instance of SqlResultSetMapping

getOrCreateMappedSuperclass

MappedSuperclass<OrmDescriptor> getOrCreateMappedSuperclass()

If not already created, a new mapped-superclass element will be created and returned. Otherwise, the first existing mapped-superclass element will be returned.

Returns:

the instance defined for the element mapped-superclass

createMappedSuperclass

MappedSuperclass<OrmDescriptor> createMappedSuperclass()

Creates a new mapped-superclass element

Returns:

the new created instance of MappedSuperclass

getAllMappedSuperclass

List<MappedSuperclass<OrmDescriptor>> getAllMappedSuperclass()

Returns all mapped-superclass elements

Returns:

list of mapped-superclass

removeAllMappedSuperclass

OrmDescriptor removeAllMappedSuperclass()

Removes all mapped-superclass elements

Returns:

the current instance of MappedSuperclass

getOrCreateEntity

Entity<OrmDescriptor> getOrCreateEntity()

If not already created, a new entity element will be created and returned. Otherwise, the first existing entity element will be returned.

Returns:

the instance defined for the element entity

createEntity

Entity<OrmDescriptor> createEntity()

Creates a new entity element

Returns:

the new created instance of Entity

getAllEntity

List<Entity<OrmDescriptor>> getAllEntity()

Returns all entity elements

Returns:

list of entity

removeAllEntity

OrmDescriptor removeAllEntity()

Removes all entity elements

Returns:

the current instance of Entity

getOrCreateEmbeddable

Embeddable<OrmDescriptor> getOrCreateEmbeddable()

If not already created, a new embeddable element will be created and returned. Otherwise, the first existing embeddable element will be returned.

Returns:

the instance defined for the element embeddable

createEmbeddable

Embeddable<OrmDescriptor> createEmbeddable()

Creates a new embeddable element

Returns:

the new created instance of Embeddable

getAllEmbeddable

List<Embeddable<OrmDescriptor>> getAllEmbeddable()

Returns all embeddable elements

Returns:

list of embeddable

removeAllEmbeddable

OrmDescriptor removeAllEmbeddable()

Removes all embeddable elements

Returns:

the current instance of Embeddable

version

OrmDescriptor version(String version)

Sets the version attribute

Parameters:

version - the value for the attribute version

Returns:

the current instance of OrmDescriptor

getVersion

String getVersion()

Returns the version attribute

Returns:

the value defined for the attribute version

removeVersion

OrmDescriptor removeVersion()

Removes the version attribute

Returns:

the current instance of OrmDescriptor