Package org.apache.jackrabbit.spi.commons.query

Class OrderQueryNode.OrderSpec

java.lang.Object
org.apache.jackrabbit.spi.commons.query.OrderQueryNode.OrderSpec
Enclosing class:
OrderQueryNode
public static final class OrderQueryNode.OrderSpec extends Object
Implements a single order specification. Contains a property name and whether it is ordered ascending or descending.

  • Constructor Details

    • OrderSpec

      public OrderSpec(Name property, boolean ascending)
      Deprecated.
      use OrderSpec(Path, boolean) instead.
      Creates a new OrderSpec for property.
      Parameters:
      property - the name of the property.
      ascending - if true the property is ordered ascending, otherwise descending.

    • OrderSpec

      public OrderSpec(Path property, boolean ascending)
      Creates a new OrderSpec for property.
      Parameters:
      property - the relative path of the property.
      ascending - if true the property is ordered ascending, otherwise descending.

  • Method Details

    • getProperty

      public Name getProperty()
      Deprecated.
      use getPropertyPath() instead.
      Returns the name of the property.
      Returns:
      the name of the property.

    • getPropertyPath

      public Path getPropertyPath()
      Returns the relative path of the property.
      Returns:
      the relative path of the property.

    • isAscending

      public boolean isAscending()
      If true the property is ordered ascending, otherwise descending.
      Returns:
      true for ascending; false for descending.

    • setAscending

      public void setAscending(boolean ascending)
      Sets the new value for the ascending property.
      Parameters:
      ascending - true for ascending; false for descending.

    • setPath

      public void setPath(Path path)
      Set a new value for the path
      Parameters:
      path - a path

    • setFunction

      public void setFunction(String name)
      Set a new value for a function
      Parameters:
      name - a function name

    • getFunction

      public String getFunction()
      Returns:
      name of the function

    • equals

      public boolean equals(Object obj)
      Returns true if this order spec is equal to obj
      Overrides:
      equals in class Object
      Parameters:
      obj - the reference object with which to compare.
      Returns:
      true if this order spec is equal to obj; false otherwise.