|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jpox.metadata.MetaData
org.jpox.metadata.ExtendableMetaData
org.jpox.metadata.IndexMetaData
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.
<!ELEMENT index (extension*, (column|field|property)*, extension*)> <!ATTLIST index name CDATA #IMPLIED> <!ATTLIST index table CDATA #IMPLIED> <!ATTLIST index unique (true|false) `false'>
Field Summary | |
protected ColumnMetaData[] |
columnMetaData
Contains the metadata for columns |
protected java.util.List |
columns
the columns elements to be included in the index. |
protected AbstractPropertyMetaData[] |
fieldMetaData
Contains the metadata for fields |
protected java.util.List |
fields
the field elements to be included in the index. |
Fields inherited from class org.jpox.metadata.ExtendableMetaData |
extensions, JPOX_VENDOR_NAME |
Fields inherited from class org.jpox.metadata.MetaData |
LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent |
Constructor Summary | |
IndexMetaData(MetaData parent,
IndexMetaData imd)
Constructor to create a copy of the passed metadata using the provided parent. |
|
IndexMetaData(java.lang.String name,
java.lang.String table,
java.lang.String unique)
Constructor. |
Method Summary | |
void |
addColumn(ColumnMetaData colmd)
Add a new ColumnMetaData element |
void |
addField(AbstractPropertyMetaData fmd)
Add a new AbstractPropertyMetaData element |
ColumnMetaData[] |
getColumnMetaData()
Accessor for columnMetaData |
AbstractPropertyMetaData[] |
getFieldMetaData()
Accessor for fieldMetaData |
java.lang.String |
getName()
Accessor for the name of the index. |
java.lang.String |
getTable()
Accessor for the table |
void |
initialise()
Method to initialise the object, creating internal convenience arrays. |
java.lang.Boolean |
isUnique()
Accessor for whether the index is unique |
java.lang.String |
toString()
Returns a string representation of the object. |
java.lang.String |
toString(java.lang.String prefix,
java.lang.String indent)
Returns a string representation of the object. |
Methods inherited from class org.jpox.metadata.ExtendableMetaData |
addExtension, addExtension, getExtension, getExtensions, getNoOfExtensions, getValueForExtension, getValuesForExtension, getValuesForExtensionStartingWith, hasExtension, removeExtension |
Methods inherited from class org.jpox.metadata.MetaData |
getParent, isCreated, isInitialised, isPopulated, isUsed, populate, setInitialised, setPopulated, setUsed |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected AbstractPropertyMetaData[] fieldMetaData
protected ColumnMetaData[] columnMetaData
protected java.util.List fields
protected java.util.List columns
Constructor Detail |
public IndexMetaData(MetaData parent, IndexMetaData imd)
parent
- The parentimd
- The metadata to copypublic IndexMetaData(java.lang.String name, java.lang.String table, java.lang.String unique)
name
- Name of indextable
- Name of the tableunique
- Whether it is unique.Method Detail |
public void initialise()
initialise
in class MetaData
public void addField(AbstractPropertyMetaData fmd)
fmd
- The AbstractPropertyMetaData to addpublic void addColumn(ColumnMetaData colmd)
addColumn
in interface ColumnMetaDataContainer
colmd
- The ColumMetaData to addpublic final AbstractPropertyMetaData[] getFieldMetaData()
public final ColumnMetaData[] getColumnMetaData()
getColumnMetaData
in interface ColumnMetaDataContainer
public final java.lang.String getName()
public final java.lang.String getTable()
public final java.lang.Boolean isUnique()
public java.lang.String toString()
toString
in class ExtendableMetaData
public java.lang.String toString(java.lang.String prefix, java.lang.String indent)
toString
in class ExtendableMetaData
prefix
- prefix stringindent
- indent string
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |