Top Description Fields Constructors Methods
org.hibernate.boot.jaxb.mapping

public Class JaxbSecondaryTable

extends Object
implements Serializable, SchemaAware
Class Inheritance
All Implemented Interfaces
org.hibernate.boot.jaxb.mapping.SchemaAware, java.io.Serializable
Annotations
@XmlAccessorType:FIELD
@XmlType
name:secondary-table
namespace:http://www.hibernate.org/xsd/orm/mapping
propOrder:primaryKeyJoinColumn, primaryKeyForeignKey, comment, check, uniqueConstraint, index
Imports
java.io.Serializable, java.util.ArrayList, .List, jakarta.xml.bind.annotation.XmlAccessType, .XmlAccessorType, .XmlAttribute, .XmlElement, .XmlType
@Target({TYPE}) @Retention(RUNTIME) public @interface SecondaryTable { String name(); String catalog() default ""; String schema() default ""; PrimaryKeyJoinColumn[] pkJoinColumns() default {}; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; }

Java class for secondary-table complex type.

The following schema fragment specifies the expected content contained within this class. 

<complexType name="secondary-table">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <sequence>
          <element name="primary-key-join-column" type="{http://www.hibernate.org/xsd/orm/mapping}primary-key-join-column" maxOccurs="unbounded" minOccurs="0"/>
          <element name="primary-key-foreign-key" type="{http://www.hibernate.org/xsd/orm/mapping}foreign-key" minOccurs="0"/>
        </sequence>
        <group ref="{http://www.hibernate.org/xsd/orm/mapping}hbm-common-table-extensions"/>
        <element name="unique-constraint" type="{http://www.hibernate.org/xsd/orm/mapping}unique-constraint" maxOccurs="unbounded" minOccurs="0"/>
        <element name="index" type="{http://www.hibernate.org/xsd/orm/mapping}index" maxOccurs="unbounded" minOccurs="0"/>
      </sequence>
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="catalog" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="schema" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="optional" type="{http://www.w3.org/2001/XMLSchema}boolean" />
    </restriction>
  </complexContent>
</complexType>

Field Summary

Modifier and TypeField and Description
protected String
catalog

protected String
check

protected String
comment

protected List<JaxbIndex>
index

protected String
name

protected Boolean
optional

protected JaxbForeignKey
primaryKeyForeignKey

protected List<JaxbPrimaryKeyJoinColumn>
primaryKeyJoinColumn

protected String
schema

protected List<JaxbUniqueConstraint>
uniqueConstraint

Constructor Summary

AccessConstructor and Description
public
JaxbSecondaryTable()

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

possible object is String
getCatalog()

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.getCatalog.

Gets the value of the catalog property.
public String

Returns:

possible object is String
getCheck()

Gets the value of the check property.

public String

Returns:

possible object is String
getComment()

Gets the value of the comment property.

public List<JaxbIndex>

Returns:

The value of the index property.
getIndex()

Gets the value of the index property.

public String

Returns:

possible object is String
getName()

Gets the value of the name property.

public JaxbForeignKey

Returns:

possible object is JaxbForeignKey
getPrimaryKeyForeignKey()

Gets the value of the primaryKeyForeignKey property.

public List<JaxbPrimaryKeyJoinColumn>

Returns:

The value of the primaryKeyJoinColumn property.
getPrimaryKeyJoinColumn()

Gets the value of the primaryKeyJoinColumn property.

public String

Returns:

possible object is String
getSchema()

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.getSchema.

Gets the value of the schema property.
public List<JaxbUniqueConstraint>

Returns:

The value of the uniqueConstraint property.
getUniqueConstraint()

Gets the value of the uniqueConstraint property.

public Boolean

Returns:

possible object is Boolean
isOptional()

Gets the value of the optional property.

public void
setCatalog(String
allowed object is String
value)

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.setCatalog.

Sets the value of the catalog property.
public void
setCheck(String
allowed object is String
value)

Sets the value of the check property.

public void
setComment(String
allowed object is String
value)

Sets the value of the comment property.

public void
setName(String
allowed object is String
value)

Sets the value of the name property.

public void
setOptional(Boolean
allowed object is Boolean
value)

Sets the value of the optional property.

public void
setPrimaryKeyForeignKey(JaxbForeignKey
allowed object is JaxbForeignKey
value)

Sets the value of the primaryKeyForeignKey property.

public void
setSchema(String
allowed object is String
value)

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.setSchema.

Sets the value of the schema property.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

catalogback to summary
protected String catalog
Annotations
@XmlAttribute
name:catalog
checkback to summary
protected String check
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
commentback to summary
protected String comment
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
indexback to summary
protected List<JaxbIndex> index
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
nameback to summary
protected String name
Annotations
@XmlAttribute
name:name
required:true
optionalback to summary
protected Boolean optional
Annotations
@XmlAttribute
name:optional
primaryKeyForeignKeyback to summary
protected JaxbForeignKey primaryKeyForeignKey
Annotations
@XmlElement
name:primary-key-foreign-key
namespace:http://www.hibernate.org/xsd/orm/mapping
primaryKeyJoinColumnback to summary
protected List<JaxbPrimaryKeyJoinColumn> primaryKeyJoinColumn
Annotations
@XmlElement
name:primary-key-join-column
namespace:http://www.hibernate.org/xsd/orm/mapping
schemaback to summary
protected String schema
Annotations
@XmlAttribute
name:schema
uniqueConstraintback to summary
protected List<JaxbUniqueConstraint> uniqueConstraint
Annotations
@XmlElement
name:unique-constraint
namespace:http://www.hibernate.org/xsd/orm/mapping

Constructor Detail

JaxbSecondaryTableback to summary
public JaxbSecondaryTable()

Method Detail

getCatalogback to summary
public String getCatalog()

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.getCatalog.

Gets the value of the catalog property.

Returns:String

possible object is String

getCheckback to summary
public String getCheck()

Gets the value of the check property.

Returns:String

possible object is String

getCommentback to summary
public String getComment()

Gets the value of the comment property.

Returns:String

possible object is String

getIndexback to summary
public List<JaxbIndex> getIndex()

Gets the value of the index 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 set method for the index property.

For example, to add a new item, do as follows: 

   getIndex().add(newItem);

Objects of the following type(s) are allowed in the list JaxbIndex

Returns:List<JaxbIndex>

The value of the index property.

getNameback to summary
public String getName()

Gets the value of the name property.

Returns:String

possible object is String

getPrimaryKeyForeignKeyback to summary
public JaxbForeignKey getPrimaryKeyForeignKey()

Gets the value of the primaryKeyForeignKey property.

Returns:JaxbForeignKey

possible object is JaxbForeignKey

getPrimaryKeyJoinColumnback to summary
public List<JaxbPrimaryKeyJoinColumn> getPrimaryKeyJoinColumn()

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

Returns:List<JaxbPrimaryKeyJoinColumn>

The value of the primaryKeyJoinColumn property.

getSchemaback to summary
public String getSchema()

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.getSchema.

Gets the value of the schema property.

Returns:String

possible object is String

getUniqueConstraintback to summary
public List<JaxbUniqueConstraint> getUniqueConstraint()

Gets the value of the uniqueConstraint 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 set method for the uniqueConstraint property.

For example, to add a new item, do as follows: 

   getUniqueConstraint().add(newItem);

Objects of the following type(s) are allowed in the list JaxbUniqueConstraint

Returns:List<JaxbUniqueConstraint>

The value of the uniqueConstraint property.

isOptionalback to summary
public Boolean isOptional()

Gets the value of the optional property.

Returns:Boolean

possible object is Boolean

setCatalogback to summary
public void setCatalog(String value)

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.setCatalog.

Sets the value of the catalog property.

Parameters
value:String

allowed object is String

setCheckback to summary
public void setCheck(String value)

Sets the value of the check property.

Parameters
value:String

allowed object is String

setCommentback to summary
public void setComment(String value)

Sets the value of the comment property.

Parameters
value:String

allowed object is String

setNameback to summary
public void setName(String value)

Sets the value of the name property.

Parameters
value:String

allowed object is String

setOptionalback to summary
public void setOptional(Boolean value)

Sets the value of the optional property.

Parameters
value:Boolean

allowed object is Boolean

setPrimaryKeyForeignKeyback to summary
public void setPrimaryKeyForeignKey(JaxbForeignKey value)

Sets the value of the primaryKeyForeignKey property.

Parameters
value:JaxbForeignKey

allowed object is JaxbForeignKey

setSchemaback to summary
public void setSchema(String value)

Implements org.hibernate.boot.jaxb.mapping.SchemaAware.setSchema.

Sets the value of the schema property.

Parameters
value:String

allowed object is String