org.datanucleus.metadata

Class IndexMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.ConstraintMetaData

org.datanucleus.metadata.IndexMetaData

All Implemented Interfaces:

Serializable

public class IndexMetaData
extends ConstraintMetaData

For schema generation, it might be useful to specify that a column or columns be indexed, and to provide the name of the index. For this purpose, an index element can be contained within a field, element, key, value, or join element, and this indicates that the column(s) associated with the referenced element should be indexed. Indexes can also be specified at the class level, by including index elements containing column elements. In this case, the column elements are mapped elsewhere, and the column elements contain only the column name.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.datanucleus.metadata.ConstraintMetaData

columnNames, memberNames, name, table

Fields inherited from class org.datanucleus.metadata.MetaData

extensions, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME

Constructor Summary

Constructors

Constructor and Description
IndexMetaData()
IndexMetaData(IndexMetaData imd) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isUnique()
IndexMetaData	setUnique(boolean unique)
String	toString(String prefix, String indent) Returns a string representation of the object.

Methods inherited from class org.datanucleus.metadata.ConstraintMetaData

addColumn, addMember, getColumnNames, getMemberNames, getName, getNumberOfColumns, getNumberOfMembers, getTable, setName, setTable

Methods inherited from class org.datanucleus.metadata.MetaData

addExtension, addExtension, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexMetaData

public IndexMetaData()

IndexMetaData

public IndexMetaData(IndexMetaData imd)

Copy constructor.

Parameters:

imd - The metadata to copy

Method Detail

isUnique

public final boolean isUnique()

setUnique

public IndexMetaData setUnique(boolean unique)

toString

public String toString(String prefix,
                       String indent)

Returns a string representation of the object. This can be used as part of a facility to output a MetaData file.

Overrides:

toString in class MetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.