Class OrderMetaData

  • All Implemented Interfaces:
    java.io.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:
    Serialized Form
    • Field Detail

      • columnName

        protected java.lang.String columnName
        The name of the column (if specified as input)
      • columns

        protected java.util.List<ColumnMetaData> columns
        the columns
      • indexMetaData

        protected IndexMetaData indexMetaData
        IndexMetaData.
      • indexed

        protected IndexedValue indexed
        The indexing value specified as input.
      • mappedBy

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

        protected java.lang.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 Detail

      • OrderMetaData

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

        public OrderMetaData()
    • Method Detail

      • 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
      • newIndexMetaData

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

        public java.lang.String getMappedBy()
      • setMappedBy

        public OrderMetaData setMappedBy​(java.lang.String mappedby)
      • newColumnMetaData

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

        public final java.lang.String getColumnName()
      • setColumnName

        public OrderMetaData setColumnName​(java.lang.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 java.lang.String getOrdering()
      • setOrdering

        public OrderMetaData setOrdering​(java.lang.String ordering)