Class OrderMetaData

java.lang.Object
org.datanucleus.metadata.MetaData
org.datanucleus.metadata.OrderMetaData
All Implemented Interfaces:
Serializable, ColumnMetaDataContainer
public class OrderMetaData extends MetaData implements ColumnMetaDataContainer
Representation of Order MetaData - the ordering of the elements of a List. This caters for 2 types of List.
  • indexed list where we add a (surrogate) index column
  • ordered list like in JPA where we use some ordering clause when retrieving (also as extension in JDO)
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • columnName

      protected String columnName
      The name of the column (if specified as input)

    • columns

      protected List<ColumnMetaData> columns
      the columns

    • indexMetaData

      protected IndexMetaData indexMetaData
      IndexMetaData.

    • indexed

      protected IndexedValue indexed
      The indexing value specified as input.

    • mappedBy

      protected String mappedBy
      Name of the field in the element that is the ordering field.

    • ordering

      protected String ordering
      Ordering when using an "ordered list" where the elements are retrieved in a particular order.

    • fieldOrders

      protected OrderMetaData.FieldOrder[] fieldOrders
      Ordering of fields (when using "ordered List"), splitting the "ordering" apart by comma-separated parts.

  • Constructor Details

    • OrderMetaData

      public OrderMetaData(OrderMetaData omd)
      Copy constructor.
      Parameters:
      omd - The metadata to copy

    • OrderMetaData

      public OrderMetaData()

  • Method Details

    • initialise

      public void initialise(ClassLoaderResolver clr)
      Method to initialise the object, creating internal convenience arrays. Initialises all sub-objects.
      Overrides:
      initialise in class MetaData
      Parameters:
      clr - Not used

    • setIndexed

      public final OrderMetaData setIndexed(IndexedValue val)

    • getIndexed

      public IndexedValue getIndexed()

    • setIndexMetaData

      public final OrderMetaData setIndexMetaData(IndexMetaData indexMetaData)

    • newIndexMetaData

      public IndexMetaData newIndexMetaData()
      Method to create a new index metadata, set it, and return it.
      Returns:
      The index metadata

    • getMappedBy

      public String getMappedBy()

    • setMappedBy

      public OrderMetaData setMappedBy(String mappedby)

    • addColumn

      public void addColumn(ColumnMetaData colmd)
      Description copied from interface: ColumnMetaDataContainer
      Add a new ColumnMetaData element
      Specified by:
      addColumn in interface ColumnMetaDataContainer
      Parameters:
      colmd - The Column MetaData

    • newColumnMetaData

      public ColumnMetaData newColumnMetaData()
      Method to create a new column metadata, set it, and return it.
      Returns:
      The column metadata

    • getColumnMetaData

      public final ColumnMetaData[] getColumnMetaData()
      Description copied from interface: ColumnMetaDataContainer
      Accessor for columnMetaData
      Specified by:
      getColumnMetaData in interface ColumnMetaDataContainer
      Returns:
      Returns the columnMetaData.

    • getColumnName

      public final String getColumnName()

    • setColumnName

      public OrderMetaData setColumnName(String column)

    • getIndexMetaData

      public final IndexMetaData getIndexMetaData()

    • isIndexedList

      public boolean isIndexedList()
      Convenience method to return if the List is an "indexed List" like in JDO2.
      Returns:
      Whether the List is indexed (if false means that it is "ordered" (like in JPA1)

    • getOrdering

      public String getOrdering()

    • setOrdering

      public OrderMetaData setOrdering(String ordering)

    • getFieldOrders

      public OrderMetaData.FieldOrder[] getFieldOrders()