XmlElementMetadata (Hibernate JavaDocs)

java.lang.Object
- java.lang.Enum<XmlElementMetadata>
- - org.hibernate.boot.model.source.internal.hbm.XmlElementMetadata

All Implemented Interfaces:

Serializable, Comparable<XmlElementMetadata>
```
public enum XmlElementMetadata
extends Enum<XmlElementMetadata>
```
Provides meta-information about XML elements.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANY` Describes the `<any/>` element
`ARRAY` Describes the `<array/>` element
`BAG` Describes the `<bag/>` element
`COLLECTION_ID` Describes the `<collection-id/>` element
`COMPONENT` Describes the `<component/>` element
`COMPOSITE_ID` Describes the `<composite-id/>` element
`DISCRIMINATOR` Describes the `<discriminator/>` element
`ELEMENT` Describes the `<element/>` element
`ID` Describes the `<id/>` element
`ID_BAG` Describes the `<id-bag/>` element
`INDEX` Describes the `<index/>` element
`INDEX_MANY_TO_MANY` Describes the `<index-many-to-many/>` element
`KEY` Describes the `<key/>` element
`KEY_MANY_TO_ONE` Describes the `<key-many-to-one/>` element
`KEY_PROPERTY` Describes the `<key-property/>` element
`LIST` Describes the `<list/>` element
`LIST_INDEX` Describes the `<list-index/>` element
`MANY_TO_ANY` Describes the `<many-to-aany/>` element
`MANY_TO_MANY` Describes the `<many-to-many/>` element
`MANY_TO_ONE` Describes the `<many-to-one/>` element
`MAP` Describes the `<map/>` element
`MAP_KEY` Describes the `<map-key/>` element
`MAP_KEY_MANY_TO_MANY` Describes the `<map-key-many-to-many/>` element
`MULTI_TENANCY` Describes the `<multi-tenancy/>` element
`NATURAL_ID` Describes the `<natural-id/>` element
`ONE_TO_ONE` Describes the `<one-to-one/>` element
`PRIMITIVE_ARRAY` Describes the `<primitive-array/>` element
`PROPERTIES` Describes the `<properties/>` element
`PROPERTY` Describes the `<property/>` element
`SET` Describes the `<set/>` element
`TIMESTAMP` Describes the `<timestamp/>` element
`VERSION` Describes the `<version/>` element

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBeNamed()` Can the source be named.
`String`	`getElementName()` The corresponding `hbm.xml` element name.
`boolean`	`isInherentlySingleColumn()` Can this source, by nature, define just a single column/formula?
`static XmlElementMetadata`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static XmlElementMetadata[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ID
```
public static final XmlElementMetadata ID
```
    Describes the <id/> element
  - COMPOSITE_ID
```
public static final XmlElementMetadata COMPOSITE_ID
```
    Describes the <composite-id/> element
  - DISCRIMINATOR
```
public static final XmlElementMetadata DISCRIMINATOR
```
    Describes the <discriminator/> element
  - MULTI_TENANCY
```
public static final XmlElementMetadata MULTI_TENANCY
```
    Describes the <multi-tenancy/> element
  - VERSION
```
public static final XmlElementMetadata VERSION
```
    Describes the <version/> element
  - TIMESTAMP
```
public static final XmlElementMetadata TIMESTAMP
```
    Describes the <timestamp/> element
  - NATURAL_ID
```
public static final XmlElementMetadata NATURAL_ID
```
    Describes the <natural-id/> element
  - PROPERTIES
```
public static final XmlElementMetadata PROPERTIES
```
    Describes the <properties/> element
  - PROPERTY
```
public static final XmlElementMetadata PROPERTY
```
    Describes the <property/> element
  - KEY_PROPERTY
```
public static final XmlElementMetadata KEY_PROPERTY
```
    Describes the <key-property/> element
  - MANY_TO_ONE
```
public static final XmlElementMetadata MANY_TO_ONE
```
    Describes the <many-to-one/> element
  - KEY_MANY_TO_ONE
```
public static final XmlElementMetadata KEY_MANY_TO_ONE
```
    Describes the <key-many-to-one/> element
  - ONE_TO_ONE
```
public static final XmlElementMetadata ONE_TO_ONE
```
    Describes the <one-to-one/> element
  - ANY
```
public static final XmlElementMetadata ANY
```
    Describes the <any/> element
  - COMPONENT
```
public static final XmlElementMetadata COMPONENT
```
    Describes the <component/> element
  - KEY
```
public static final XmlElementMetadata KEY
```
    Describes the <key/> element
  - SET
```
public static final XmlElementMetadata SET
```
    Describes the <set/> element
  - LIST
```
public static final XmlElementMetadata LIST
```
    Describes the <list/> element
  - BAG
```
public static final XmlElementMetadata BAG
```
    Describes the <bag/> element
  - ID_BAG
```
public static final XmlElementMetadata ID_BAG
```
    Describes the <id-bag/> element
  - MAP
```
public static final XmlElementMetadata MAP
```
    Describes the <map/> element
  - ARRAY
```
public static final XmlElementMetadata ARRAY
```
    Describes the <array/> element
  - PRIMITIVE_ARRAY
```
public static final XmlElementMetadata PRIMITIVE_ARRAY
```
    Describes the <primitive-array/> element
  - COLLECTION_ID
```
public static final XmlElementMetadata COLLECTION_ID
```
    Describes the <collection-id/> element
  - ELEMENT
```
public static final XmlElementMetadata ELEMENT
```
    Describes the <element/> element
  - MANY_TO_MANY
```
public static final XmlElementMetadata MANY_TO_MANY
```
    Describes the <many-to-many/> element
  - MANY_TO_ANY
```
public static final XmlElementMetadata MANY_TO_ANY
```
    Describes the <many-to-aany/> element
  - MAP_KEY
```
public static final XmlElementMetadata MAP_KEY
```
    Describes the <map-key/> element
  - MAP_KEY_MANY_TO_MANY
```
public static final XmlElementMetadata MAP_KEY_MANY_TO_MANY
```
    Describes the <map-key-many-to-many/> element
  - INDEX
```
public static final XmlElementMetadata INDEX
```
    Describes the <index/> element
  - INDEX_MANY_TO_MANY
```
public static final XmlElementMetadata INDEX_MANY_TO_MANY
```
    Describes the <index-many-to-many/> element
  - LIST_INDEX
```
public static final XmlElementMetadata LIST_INDEX
```
    Describes the <list-index/> element
- Method Detail
  - values
```
public static XmlElementMetadata[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (XmlElementMetadata c : XmlElementMetadata.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static XmlElementMetadata valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getElementName
```
public String getElementName()
```
    The corresponding hbm.xml element name. Used in error reporting
    
    Returns:
    
    The hbm.xml element name
  - isInherentlySingleColumn
```
public boolean isInherentlySingleColumn()
```
    Can this source, by nature, define just a single column/formula?
    
    Returns:
    
    true indicates that the source will refer to just a single column.
  - canBeNamed
```
public boolean canBeNamed()
```
    Can the source be named. This is used in implicit naming (naming strategy).
    
    Returns:
    
    true indicates that the source can be named and therefore the column (assuming just one) is eligible for implicit naming.

Enum XmlElementMetadata

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ID

COMPOSITE_ID

DISCRIMINATOR

MULTI_TENANCY

VERSION

TIMESTAMP

NATURAL_ID

PROPERTIES

PROPERTY

KEY_PROPERTY

MANY_TO_ONE

KEY_MANY_TO_ONE

ONE_TO_ONE

ANY

COMPONENT

KEY

SET

LIST

BAG

ID_BAG

MAP

ARRAY

PRIMITIVE_ARRAY

COLLECTION_ID

ELEMENT

MANY_TO_MANY

MANY_TO_ANY

MAP_KEY

MAP_KEY_MANY_TO_MANY

INDEX

INDEX_MANY_TO_MANY

LIST_INDEX

Method Detail

values

valueOf

getElementName

isInherentlySingleColumn

canBeNamed