org.apache.openejb.jee.jpa.EntityMappings Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.openejb.jee.jpa;
import org.apache.openejb.jee.KeyedCollection;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.CollapsedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
/**
* 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>
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"description",
"persistenceUnitMetadata",
"_package",
"schema",
"catalog",
"access",
"sequenceGenerator",
"tableGenerator",
"namedQuery",
"namedNativeQuery",
"sqlResultSetMapping",
"mappedSuperclass",
"entity",
"embeddable"
})
@XmlRootElement(name = "entity-mappings")
public class EntityMappings {
protected String description;
@XmlElement(name = "persistence-unit-metadata")
protected PersistenceUnitMetadata persistenceUnitMetadata;
@XmlElement(name = "package")
protected String _package;
protected String schema;
protected String catalog;
protected AccessType access;
@XmlElement(name = "sequence-generator")
protected List sequenceGenerator;
@XmlElement(name = "table-generator")
protected List tableGenerator;
@XmlElement(name = "named-query")
protected List namedQuery;
@XmlElement(name = "named-native-query")
protected List namedNativeQuery;
@XmlElement(name = "sql-result-set-mapping")
protected List sqlResultSetMapping;
@XmlElement(name = "mapped-superclass")
protected KeyedCollection mappedSuperclass;
protected KeyedCollection entity;
protected List embeddable;
@XmlAttribute(required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
protected String version = "2.0";
/**
* Gets the value of the description property.
*
* @return possible object is
* {@link String }
*/
public String getDescription() {
return description;
}
/**
* Sets the value of the description property.
*
* @param value allowed object is
* {@link String }
*/
public void setDescription(final String value) {
this.description = value;
}
/**
* Gets the value of the persistenceUnitMetadata property.
*
* @return possible object is
* {@link PersistenceUnitMetadata }
*/
public PersistenceUnitMetadata getPersistenceUnitMetadata() {
return persistenceUnitMetadata;
}
/**
* Sets the value of the persistenceUnitMetadata property.
*
* @param value allowed object is
* {@link PersistenceUnitMetadata }
*/
public void setPersistenceUnitMetadata(final PersistenceUnitMetadata value) {
this.persistenceUnitMetadata = value;
}
/**
* Gets the value of the package property.
*
* @return possible object is
* {@link String }
*/
public String getPackage() {
return _package;
}
/**
* Sets the value of the package property.
*
* @param value allowed object is
* {@link String }
*/
public void setPackage(final String value) {
this._package = value;
}
/**
* Gets the value of the schema property.
*
* @return possible object is
* {@link String }
*/
public String getSchema() {
return schema;
}
/**
* Sets the value of the schema property.
*
* @param value allowed object is
* {@link String }
*/
public void setSchema(final String value) {
this.schema = value;
}
/**
* Gets the value of the catalog property.
*
* @return possible object is
* {@link String }
*/
public String getCatalog() {
return catalog;
}
/**
* Sets the value of the catalog property.
*
* @param value allowed object is
* {@link String }
*/
public void setCatalog(final String value) {
this.catalog = value;
}
/**
* Gets the value of the access property.
*
* @return possible object is
* {@link AccessType }
*/
public AccessType getAccess() {
return access;
}
/**
* Sets the value of the access property.
*
* @param value allowed object is
* {@link AccessType }
*/
public void setAccess(final AccessType value) {
this.access = value;
}
/**
* 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
* {@link SequenceGenerator }
*/
public List getSequenceGenerator() {
if (sequenceGenerator == null) {
sequenceGenerator = new ArrayList();
}
return this.sequenceGenerator;
}
/**
* 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
* {@link TableGenerator }
*/
public List getTableGenerator() {
if (tableGenerator == null) {
tableGenerator = new ArrayList();
}
return this.tableGenerator;
}
/**
* 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
* {@link NamedQuery }
*/
public List getNamedQuery() {
if (namedQuery == null) {
namedQuery = new ArrayList();
}
return this.namedQuery;
}
/**
* 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
* {@link NamedNativeQuery }
*/
public List getNamedNativeQuery() {
if (namedNativeQuery == null) {
namedNativeQuery = new ArrayList();
}
return this.namedNativeQuery;
}
/**
* 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
* {@link SqlResultSetMapping }
*/
public List getSqlResultSetMapping() {
if (sqlResultSetMapping == null) {
sqlResultSetMapping = new ArrayList();
}
return this.sqlResultSetMapping;
}
/**
* 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
* {@link MappedSuperclass }
*/
public Collection getMappedSuperclass() {
if (mappedSuperclass == null) {
mappedSuperclass = new KeyedCollection();
}
return this.mappedSuperclass;
}
public Map getMappedSuperclassMap() {
return ((KeyedCollection) getMappedSuperclass()).toMap();
}
/**
* 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
* {@link Entity }
*/
public Collection getEntity() {
if (entity == null) {
entity = new KeyedCollection();
}
return this.entity;
}
public Map getEntityMap() {
return ((KeyedCollection) getEntity()).toMap();
}
/**
* 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
* {@link Embeddable }
*/
public List getEmbeddable() {
if (embeddable == null) {
embeddable = new ArrayList();
}
return this.embeddable;
}
/**
* Gets the value of the version property.
*
* @return possible object is
* {@link String }
*/
public String getVersion() {
if (version == null) {
return "2.0";
} else {
return version;
}
}
/**
* Sets the value of the version property.
*
* @param value allowed object is
* {@link String }
*/
public void setVersion(final String value) {
this.version = value;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy