org.hibernate.jpamodelgen.xml.jaxb.Entity Maven / Gradle / Ivy
Show all versions of hibernate-jpamodelgen Show documentation
package org.hibernate.jpamodelgen.xml.jaxb;
import java.util.ArrayList;
import java.util.List;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
/**
*
*
* Defines the settings and mappings for an entity. Is allowed to be
* sparsely populated and used in conjunction with the annotations.
* Alternatively, the metadata-complete attribute can be used to
* indicate that no annotations on the entity class (and its fields
* or properties) are to be processed. If this is the case then
* the defaulting rules for the entity and its subelements will
* be recursively applied.
*
* @Target(TYPE) @Retention(RUNTIME)
* public @interface Entity {
* String name() default "";
* }
*
*
*
* Java class for entity complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
{@code
*
*
*
*
*
*
*
*
*
*
* }
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "entity", namespace = "https://jakarta.ee/xml/ns/persistence/orm", propOrder = {
"description",
"table",
"secondaryTable",
"primaryKeyJoinColumn",
"primaryKeyForeignKey",
"idClass",
"inheritance",
"discriminatorValue",
"discriminatorColumn",
"sequenceGenerator",
"tableGenerator",
"namedQuery",
"namedNativeQuery",
"namedStoredProcedureQuery",
"sqlResultSetMapping",
"excludeDefaultListeners",
"excludeSuperclassListeners",
"entityListeners",
"prePersist",
"postPersist",
"preRemove",
"postRemove",
"preUpdate",
"postUpdate",
"postLoad",
"attributeOverride",
"associationOverride",
"convert",
"namedEntityGraph",
"attributes"
})
public class Entity {
@XmlElement(namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected String description;
@XmlElement(namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected Table table;
@XmlElement(name = "secondary-table", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List secondaryTable;
@XmlElement(name = "primary-key-join-column", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List primaryKeyJoinColumn;
@XmlElement(name = "primary-key-foreign-key", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected ForeignKey primaryKeyForeignKey;
@XmlElement(name = "id-class", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected IdClass idClass;
@XmlElement(namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected Inheritance inheritance;
@XmlElement(name = "discriminator-value", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected String discriminatorValue;
@XmlElement(name = "discriminator-column", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected DiscriminatorColumn discriminatorColumn;
@XmlElement(name = "sequence-generator", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected SequenceGenerator sequenceGenerator;
@XmlElement(name = "table-generator", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected TableGenerator tableGenerator;
@XmlElement(name = "named-query", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List namedQuery;
@XmlElement(name = "named-native-query", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List namedNativeQuery;
@XmlElement(name = "named-stored-procedure-query", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List namedStoredProcedureQuery;
@XmlElement(name = "sql-result-set-mapping", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List sqlResultSetMapping;
@XmlElement(name = "exclude-default-listeners", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected EmptyType excludeDefaultListeners;
@XmlElement(name = "exclude-superclass-listeners", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected EmptyType excludeSuperclassListeners;
@XmlElement(name = "entity-listeners", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected EntityListeners entityListeners;
@XmlElement(name = "pre-persist", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected PrePersist prePersist;
@XmlElement(name = "post-persist", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected PostPersist postPersist;
@XmlElement(name = "pre-remove", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected PreRemove preRemove;
@XmlElement(name = "post-remove", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected PostRemove postRemove;
@XmlElement(name = "pre-update", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected PreUpdate preUpdate;
@XmlElement(name = "post-update", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected PostUpdate postUpdate;
@XmlElement(name = "post-load", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected PostLoad postLoad;
@XmlElement(name = "attribute-override", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List attributeOverride;
@XmlElement(name = "association-override", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List associationOverride;
@XmlElement(namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List convert;
@XmlElement(name = "named-entity-graph", namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected List namedEntityGraph;
@XmlElement(namespace = "https://jakarta.ee/xml/ns/persistence/orm")
protected Attributes attributes;
@XmlAttribute(name = "name")
protected String name;
@XmlAttribute(name = "class", required = true)
protected String clazz;
@XmlAttribute(name = "access")
protected AccessType access;
@XmlAttribute(name = "cacheable")
protected Boolean cacheable;
@XmlAttribute(name = "metadata-complete")
protected Boolean metadataComplete;
/**
* 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(String value) {
this.description = value;
}
/**
* Gets the value of the table property.
*
* @return
* possible object is
* {@link Table }
*
*/
public Table getTable() {
return table;
}
/**
* Sets the value of the table property.
*
* @param value
* allowed object is
* {@link Table }
*
*/
public void setTable(Table value) {
this.table = value;
}
/**
* Gets the value of the secondaryTable 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 Jakarta XML Binding object.
* This is why there is not a {@code set} method for the secondaryTable property.
*
*
* For example, to add a new item, do as follows:
*
* getSecondaryTable().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link SecondaryTable }
*
*
* @return
* The value of the secondaryTable property.
*/
public List getSecondaryTable() {
if (secondaryTable == null) {
secondaryTable = new ArrayList<>();
}
return this.secondaryTable;
}
/**
* Gets the value of the primaryKeyJoinColumn 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 Jakarta XML Binding object.
* This is why there is not a {@code set} method for the primaryKeyJoinColumn property.
*
*
* For example, to add a new item, do as follows:
*
* getPrimaryKeyJoinColumn().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link PrimaryKeyJoinColumn }
*
*
* @return
* The value of the primaryKeyJoinColumn property.
*/
public List getPrimaryKeyJoinColumn() {
if (primaryKeyJoinColumn == null) {
primaryKeyJoinColumn = new ArrayList<>();
}
return this.primaryKeyJoinColumn;
}
/**
* Gets the value of the primaryKeyForeignKey property.
*
* @return
* possible object is
* {@link ForeignKey }
*
*/
public ForeignKey getPrimaryKeyForeignKey() {
return primaryKeyForeignKey;
}
/**
* Sets the value of the primaryKeyForeignKey property.
*
* @param value
* allowed object is
* {@link ForeignKey }
*
*/
public void setPrimaryKeyForeignKey(ForeignKey value) {
this.primaryKeyForeignKey = value;
}
/**
* Gets the value of the idClass property.
*
* @return
* possible object is
* {@link IdClass }
*
*/
public IdClass getIdClass() {
return idClass;
}
/**
* Sets the value of the idClass property.
*
* @param value
* allowed object is
* {@link IdClass }
*
*/
public void setIdClass(IdClass value) {
this.idClass = value;
}
/**
* Gets the value of the inheritance property.
*
* @return
* possible object is
* {@link Inheritance }
*
*/
public Inheritance getInheritance() {
return inheritance;
}
/**
* Sets the value of the inheritance property.
*
* @param value
* allowed object is
* {@link Inheritance }
*
*/
public void setInheritance(Inheritance value) {
this.inheritance = value;
}
/**
* Gets the value of the discriminatorValue property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getDiscriminatorValue() {
return discriminatorValue;
}
/**
* Sets the value of the discriminatorValue property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setDiscriminatorValue(String value) {
this.discriminatorValue = value;
}
/**
* Gets the value of the discriminatorColumn property.
*
* @return
* possible object is
* {@link DiscriminatorColumn }
*
*/
public DiscriminatorColumn getDiscriminatorColumn() {
return discriminatorColumn;
}
/**
* Sets the value of the discriminatorColumn property.
*
* @param value
* allowed object is
* {@link DiscriminatorColumn }
*
*/
public void setDiscriminatorColumn(DiscriminatorColumn value) {
this.discriminatorColumn = value;
}
/**
* Gets the value of the sequenceGenerator property.
*
* @return
* possible object is
* {@link SequenceGenerator }
*
*/
public SequenceGenerator getSequenceGenerator() {
return sequenceGenerator;
}
/**
* Sets the value of the sequenceGenerator property.
*
* @param value
* allowed object is
* {@link SequenceGenerator }
*
*/
public void setSequenceGenerator(SequenceGenerator value) {
this.sequenceGenerator = value;
}
/**
* Gets the value of the tableGenerator property.
*
* @return
* possible object is
* {@link TableGenerator }
*
*/
public TableGenerator getTableGenerator() {
return tableGenerator;
}
/**
* Sets the value of the tableGenerator property.
*
* @param value
* allowed object is
* {@link TableGenerator }
*
*/
public void setTableGenerator(TableGenerator value) {
this.tableGenerator = value;
}
/**
* 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 Jakarta XML Binding object.
* This is why there is not a {@code 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 }
*
*
* @return
* The value of the namedQuery property.
*/
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 Jakarta XML Binding object.
* This is why there is not a {@code 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 }
*
*
* @return
* The value of the namedNativeQuery property.
*/
public List getNamedNativeQuery() {
if (namedNativeQuery == null) {
namedNativeQuery = new ArrayList<>();
}
return this.namedNativeQuery;
}
/**
* Gets the value of the namedStoredProcedureQuery 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 Jakarta XML Binding object.
* This is why there is not a {@code set} method for the namedStoredProcedureQuery property.
*
*
* For example, to add a new item, do as follows:
*
* getNamedStoredProcedureQuery().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link NamedStoredProcedureQuery }
*
*
* @return
* The value of the namedStoredProcedureQuery property.
*/
public List getNamedStoredProcedureQuery() {
if (namedStoredProcedureQuery == null) {
namedStoredProcedureQuery = new ArrayList<>();
}
return this.namedStoredProcedureQuery;
}
/**
* 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 Jakarta XML Binding object.
* This is why there is not a {@code 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 }
*
*
* @return
* The value of the sqlResultSetMapping property.
*/
public List getSqlResultSetMapping() {
if (sqlResultSetMapping == null) {
sqlResultSetMapping = new ArrayList<>();
}
return this.sqlResultSetMapping;
}
/**
* Gets the value of the excludeDefaultListeners property.
*
* @return
* possible object is
* {@link EmptyType }
*
*/
public EmptyType getExcludeDefaultListeners() {
return excludeDefaultListeners;
}
/**
* Sets the value of the excludeDefaultListeners property.
*
* @param value
* allowed object is
* {@link EmptyType }
*
*/
public void setExcludeDefaultListeners(EmptyType value) {
this.excludeDefaultListeners = value;
}
/**
* Gets the value of the excludeSuperclassListeners property.
*
* @return
* possible object is
* {@link EmptyType }
*
*/
public EmptyType getExcludeSuperclassListeners() {
return excludeSuperclassListeners;
}
/**
* Sets the value of the excludeSuperclassListeners property.
*
* @param value
* allowed object is
* {@link EmptyType }
*
*/
public void setExcludeSuperclassListeners(EmptyType value) {
this.excludeSuperclassListeners = value;
}
/**
* Gets the value of the entityListeners property.
*
* @return
* possible object is
* {@link EntityListeners }
*
*/
public EntityListeners getEntityListeners() {
return entityListeners;
}
/**
* Sets the value of the entityListeners property.
*
* @param value
* allowed object is
* {@link EntityListeners }
*
*/
public void setEntityListeners(EntityListeners value) {
this.entityListeners = value;
}
/**
* Gets the value of the prePersist property.
*
* @return
* possible object is
* {@link PrePersist }
*
*/
public PrePersist getPrePersist() {
return prePersist;
}
/**
* Sets the value of the prePersist property.
*
* @param value
* allowed object is
* {@link PrePersist }
*
*/
public void setPrePersist(PrePersist value) {
this.prePersist = value;
}
/**
* Gets the value of the postPersist property.
*
* @return
* possible object is
* {@link PostPersist }
*
*/
public PostPersist getPostPersist() {
return postPersist;
}
/**
* Sets the value of the postPersist property.
*
* @param value
* allowed object is
* {@link PostPersist }
*
*/
public void setPostPersist(PostPersist value) {
this.postPersist = value;
}
/**
* Gets the value of the preRemove property.
*
* @return
* possible object is
* {@link PreRemove }
*
*/
public PreRemove getPreRemove() {
return preRemove;
}
/**
* Sets the value of the preRemove property.
*
* @param value
* allowed object is
* {@link PreRemove }
*
*/
public void setPreRemove(PreRemove value) {
this.preRemove = value;
}
/**
* Gets the value of the postRemove property.
*
* @return
* possible object is
* {@link PostRemove }
*
*/
public PostRemove getPostRemove() {
return postRemove;
}
/**
* Sets the value of the postRemove property.
*
* @param value
* allowed object is
* {@link PostRemove }
*
*/
public void setPostRemove(PostRemove value) {
this.postRemove = value;
}
/**
* Gets the value of the preUpdate property.
*
* @return
* possible object is
* {@link PreUpdate }
*
*/
public PreUpdate getPreUpdate() {
return preUpdate;
}
/**
* Sets the value of the preUpdate property.
*
* @param value
* allowed object is
* {@link PreUpdate }
*
*/
public void setPreUpdate(PreUpdate value) {
this.preUpdate = value;
}
/**
* Gets the value of the postUpdate property.
*
* @return
* possible object is
* {@link PostUpdate }
*
*/
public PostUpdate getPostUpdate() {
return postUpdate;
}
/**
* Sets the value of the postUpdate property.
*
* @param value
* allowed object is
* {@link PostUpdate }
*
*/
public void setPostUpdate(PostUpdate value) {
this.postUpdate = value;
}
/**
* Gets the value of the postLoad property.
*
* @return
* possible object is
* {@link PostLoad }
*
*/
public PostLoad getPostLoad() {
return postLoad;
}
/**
* Sets the value of the postLoad property.
*
* @param value
* allowed object is
* {@link PostLoad }
*
*/
public void setPostLoad(PostLoad value) {
this.postLoad = value;
}
/**
* Gets the value of the attributeOverride 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 Jakarta XML Binding object.
* This is why there is not a {@code set} method for the attributeOverride property.
*
*
* For example, to add a new item, do as follows:
*
* getAttributeOverride().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link AttributeOverride }
*
*
* @return
* The value of the attributeOverride property.
*/
public List getAttributeOverride() {
if (attributeOverride == null) {
attributeOverride = new ArrayList<>();
}
return this.attributeOverride;
}
/**
* Gets the value of the associationOverride 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 Jakarta XML Binding object.
* This is why there is not a {@code set} method for the associationOverride property.
*
*
* For example, to add a new item, do as follows:
*
* getAssociationOverride().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link AssociationOverride }
*
*
* @return
* The value of the associationOverride property.
*/
public List getAssociationOverride() {
if (associationOverride == null) {
associationOverride = new ArrayList<>();
}
return this.associationOverride;
}
/**
* Gets the value of the convert 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 Jakarta XML Binding object.
* This is why there is not a {@code set} method for the convert property.
*
*
* For example, to add a new item, do as follows:
*
* getConvert().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Convert }
*
*
* @return
* The value of the convert property.
*/
public List getConvert() {
if (convert == null) {
convert = new ArrayList<>();
}
return this.convert;
}
/**
* Gets the value of the namedEntityGraph 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 Jakarta XML Binding object.
* This is why there is not a {@code set} method for the namedEntityGraph property.
*
*
* For example, to add a new item, do as follows:
*
* getNamedEntityGraph().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link NamedEntityGraph }
*
*
* @return
* The value of the namedEntityGraph property.
*/
public List getNamedEntityGraph() {
if (namedEntityGraph == null) {
namedEntityGraph = new ArrayList<>();
}
return this.namedEntityGraph;
}
/**
* Gets the value of the attributes property.
*
* @return
* possible object is
* {@link Attributes }
*
*/
public Attributes getAttributes() {
return attributes;
}
/**
* Sets the value of the attributes property.
*
* @param value
* allowed object is
* {@link Attributes }
*
*/
public void setAttributes(Attributes value) {
this.attributes = value;
}
/**
* Gets the value of the name property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getName() {
return name;
}
/**
* Sets the value of the name property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setName(String value) {
this.name = value;
}
/**
* Gets the value of the clazz property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getClazz() {
return clazz;
}
/**
* Sets the value of the clazz property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setClazz(String value) {
this.clazz = 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(AccessType value) {
this.access = value;
}
/**
* Gets the value of the cacheable property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isCacheable() {
return cacheable;
}
/**
* Sets the value of the cacheable property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setCacheable(Boolean value) {
this.cacheable = value;
}
/**
* Gets the value of the metadataComplete property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isMetadataComplete() {
return metadataComplete;
}
/**
* Sets the value of the metadataComplete property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setMetadataComplete(Boolean value) {
this.metadataComplete = value;
}
}