|
| |
|
| java.lang.Object
 org.jpox.metadata.MetaData
org.jpox.metadata.OrderMetaData
| OrderMetaData | | public class OrderMetaData extends MetaData implements ColumnMetaDataContainer(Code) | | Representation of Order MetaData - the ordering of the elements of a List.
This caters for 2 types of List.
- indexed list like in JDO2 where we add an index column
- ordered list like in JPA1 where we use some ordering clause when retrieving
version:
$Revision: 1.20 $ |
| Inner Class :public static class FieldOrder | |
| columnName | | final String columnName(Code) | | The name of the column (if specified as input)
|
| fieldOrders | | protected FieldOrder[] fieldOrders(Code) | | Ordering of fields (when using "ordered List").
|
| mappedBy | | final protected String mappedBy(Code) | | Name of the field in the element that is the ordering field.
|
| ordering | | protected String ordering(Code) | | Ordering when using an "ordered list" where the elements are retrieved in a particular order.
Only used until initialise().
|
| OrderMetaData | | public OrderMetaData(MetaData parent, OrderMetaData omd)(Code) | | Constructor to create a copy of the passed metadata using the provided parent.
Parameters:
parent - The parent
Parameters:
omd - The metadata to copy |
| OrderMetaData | | public OrderMetaData(String column, String indexed, String mappedBy)(Code) | | Constructor when defining an "indexed list" (like JDO2).
Parameters:
column - Name of column
Parameters:
indexed - The indexed value
Parameters:
mappedBy - The field in the element that provides the ordering |
| OrderMetaData | | public OrderMetaData(String ordering)(Code) | | Constructor when defining an "ordered list" (like JPA1)
Parameters:
ordering - ordering when using an ordered list where the elements are retrieved in a particular order |
| addColumn | | public void addColumn(ColumnMetaData colmd)(Code) | | Add a new ColumnMetaData element
Parameters:
colmd - The Column MetaData |
| getColumnMetaData | | final public ColumnMetaData[] getColumnMetaData()(Code) | | Accessor for the Column MetaData for the columns
Returns the columnMetaData. |
| getColumnName | | final public String getColumnName()(Code) | | Accessor for the column name
Returns the column. |
| getFieldOrders | | public FieldOrder[] getFieldOrders()(Code) | | Accessor for field ordering (if using "ordered List".
Field orders |
| getIndexMetaData | | final public IndexMetaData getIndexMetaData()(Code) | | Accessor for indexMetaData
Returns the indexMetaData. |
| getMappedBy | | public String getMappedBy()(Code) | | Accessor for the field in the element that provides the ordering.
Field in the value that provides the ordering. |
| initialise | | public void initialise()(Code) | | Method to initialise the object, creating internal convenience arrays.
Initialises all sub-objects.
|
| isIndexedList | | public boolean isIndexedList()(Code) | | Convenience method to return if the List is an "indexed List" like in JDO2.
Whether the List is indexed (if false means that it is "ordered" (like in JPA1) |
| setIndexMetaData | | final public void setIndexMetaData(IndexMetaData indexMetaData)(Code) | | Mutator for the index MetaData
Parameters:
indexMetaData - The indexMetaData to set. |
| toString | | public String toString(String prefix, String indent)(Code) | | Returns a string representation of the object using a prefix
This can be used as part of a facility to output a MetaData file.
Parameters:
prefix - prefix string
Parameters:
indent - indent string a string representation of the object. |
|
|
|