Top Description Fields Constructors Methods
org.hibernate.boot.model.source.internal.hbm

public final Enum XmlElementMetadata

extends Enum<XmlElementMetadata>
Class Inheritance
Imports
java.util.Locale
Provides meta-information about XML elements.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
public static final XmlElementMetadata
ANY

Describes the <any/> element

public static final XmlElementMetadata
ARRAY

Describes the <array/> element

public static final XmlElementMetadata
BAG

Describes the <bag/> element

private final boolean
canBeNamed

public static final XmlElementMetadata
COLLECTION_ID

Describes the <collection-id/> element

public static final XmlElementMetadata
COMPONENT

Describes the <component/> element

public static final XmlElementMetadata
COMPOSITE_ID

Describes the <composite-id/> element

public static final XmlElementMetadata
DISCRIMINATOR

Describes the <discriminator/> element

public static final XmlElementMetadata
ELEMENT

Describes the <element/> element

public static final XmlElementMetadata
ID

Describes the <id/> element

public static final XmlElementMetadata
ID_BAG

Describes the <id-bag/> element

public static final XmlElementMetadata
INDEX

Describes the <index/> element

public static final XmlElementMetadata
INDEX_MANY_TO_MANY

Describes the <index-many-to-many/> element

private final boolean
inherentlySingleColumn

public static final XmlElementMetadata
KEY

Describes the <key/> element

public static final XmlElementMetadata
KEY_MANY_TO_ONE

Describes the <key-many-to-one/> element

public static final XmlElementMetadata
KEY_PROPERTY

Describes the <key-property/> element

public static final XmlElementMetadata
LIST

Describes the <list/> element

public static final XmlElementMetadata
LIST_INDEX

Describes the <list-index/> element

public static final XmlElementMetadata
MANY_TO_ANY

Describes the <many-to-aany/> element

public static final XmlElementMetadata
MANY_TO_MANY

Describes the <many-to-many/> element

public static final XmlElementMetadata
MANY_TO_ONE

Describes the <many-to-one/> element

public static final XmlElementMetadata
MAP

Describes the <map/> element

public static final XmlElementMetadata
MAP_KEY

Describes the <map-key/> element

public static final XmlElementMetadata
MAP_KEY_MANY_TO_MANY

Describes the <map-key-many-to-many/> element

public static final XmlElementMetadata
MULTI_TENANCY

Describes the <multi-tenancy/> element

public static final XmlElementMetadata
NATURAL_ID

Describes the <natural-id/> element

public static final XmlElementMetadata
ONE_TO_ONE

Describes the <one-to-one/> element

public static final XmlElementMetadata
PRIMITIVE_ARRAY

Describes the <primitive-array/> element

public static final XmlElementMetadata
PROPERTIES

Describes the <properties/> element

public static final XmlElementMetadata
PROPERTY

Describes the <property/> element

public static final XmlElementMetadata
SET

Describes the <set/> element

public static final XmlElementMetadata
TIMESTAMP

Describes the <timestamp/> element

public static final XmlElementMetadata
VERSION

Describes the <version/> element

Constructor Summary

AccessConstructor and Description
private
XmlElementMetadata(boolean inherentlySingleColumn, boolean canBeNamed)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true indicates that the source can be named and therefore the column (assuming just one) is eligible for implicit naming.
canBeNamed()

Can the source be named.

public String

Returns:

The hbm.xml element name
getElementName()

The corresponding hbm.xml element name.

public boolean

Returns:

true indicates that the source will refer to just a single column.
isInherentlySingleColumn()

Can this source, by nature, define just a single column/formula?

public static XmlElementMetadata
valueOf(String name)

public static XmlElementMetadata[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ANYback to summary
public static final XmlElementMetadata ANY

Describes the <any/> element

ARRAYback to summary
public static final XmlElementMetadata ARRAY

Describes the <array/> element

BAGback to summary
public static final XmlElementMetadata BAG

Describes the <bag/> element

canBeNamedback to summary
private final boolean canBeNamed
COLLECTION_IDback to summary
public static final XmlElementMetadata COLLECTION_ID

Describes the <collection-id/> element

COMPONENTback to summary
public static final XmlElementMetadata COMPONENT

Describes the <component/> element

COMPOSITE_IDback to summary
public static final XmlElementMetadata COMPOSITE_ID

Describes the <composite-id/> element

DISCRIMINATORback to summary
public static final XmlElementMetadata DISCRIMINATOR

Describes the <discriminator/> element

ELEMENTback to summary
public static final XmlElementMetadata ELEMENT

Describes the <element/> element

IDback to summary
public static final XmlElementMetadata ID

Describes the <id/> element

ID_BAGback to summary
public static final XmlElementMetadata ID_BAG

Describes the <id-bag/> element

INDEXback to summary
public static final XmlElementMetadata INDEX

Describes the <index/> element

INDEX_MANY_TO_MANYback to summary
public static final XmlElementMetadata INDEX_MANY_TO_MANY

Describes the <index-many-to-many/> element

inherentlySingleColumnback to summary
private final boolean inherentlySingleColumn
KEYback to summary
public static final XmlElementMetadata KEY

Describes the <key/> element

KEY_MANY_TO_ONEback to summary
public static final XmlElementMetadata KEY_MANY_TO_ONE

Describes the <key-many-to-one/> element

KEY_PROPERTYback to summary
public static final XmlElementMetadata KEY_PROPERTY

Describes the <key-property/> element

LISTback to summary
public static final XmlElementMetadata LIST

Describes the <list/> element

LIST_INDEXback to summary
public static final XmlElementMetadata LIST_INDEX

Describes the <list-index/> element

MANY_TO_ANYback to summary
public static final XmlElementMetadata MANY_TO_ANY

Describes the <many-to-aany/> element

MANY_TO_MANYback to summary
public static final XmlElementMetadata MANY_TO_MANY

Describes the <many-to-many/> element

MANY_TO_ONEback to summary
public static final XmlElementMetadata MANY_TO_ONE

Describes the <many-to-one/> element

MAPback to summary
public static final XmlElementMetadata MAP

Describes the <map/> element

MAP_KEYback to summary
public static final XmlElementMetadata MAP_KEY

Describes the <map-key/> element

MAP_KEY_MANY_TO_MANYback to summary
public static final XmlElementMetadata MAP_KEY_MANY_TO_MANY

Describes the <map-key-many-to-many/> element

MULTI_TENANCYback to summary
public static final XmlElementMetadata MULTI_TENANCY

Describes the <multi-tenancy/> element

NATURAL_IDback to summary
public static final XmlElementMetadata NATURAL_ID

Describes the <natural-id/> element

ONE_TO_ONEback to summary
public static final XmlElementMetadata ONE_TO_ONE

Describes the <one-to-one/> element

PRIMITIVE_ARRAYback to summary
public static final XmlElementMetadata PRIMITIVE_ARRAY

Describes the <primitive-array/> element

PROPERTIESback to summary
public static final XmlElementMetadata PROPERTIES

Describes the <properties/> element

PROPERTYback to summary
public static final XmlElementMetadata PROPERTY

Describes the <property/> element

SETback to summary
public static final XmlElementMetadata SET

Describes the <set/> element

TIMESTAMPback to summary
public static final XmlElementMetadata TIMESTAMP

Describes the <timestamp/> element

VERSIONback to summary
public static final XmlElementMetadata VERSION

Describes the <version/> element

Constructor Detail

XmlElementMetadataback to summary
private XmlElementMetadata(boolean inherentlySingleColumn, boolean canBeNamed)

Method Detail

canBeNamedback to summary
public boolean canBeNamed()

Can the source be named. This is used in implicit naming (naming strategy).

Returns:boolean

true indicates that the source can be named and therefore the column (assuming just one) is eligible for implicit naming.

getElementNameback to summary
public String getElementName()

The corresponding hbm.xml element name. Used in error reporting

Returns:String

The hbm.xml element name

isInherentlySingleColumnback to summary
public boolean isInherentlySingleColumn()

Can this source, by nature, define just a single column/formula?

Returns:boolean

true indicates that the source will refer to just a single column.

valueOfback to summary
public static XmlElementMetadata valueOf(String name)
valuesback to summary
public static XmlElementMetadata[] values()