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 Summary
Constructors Constructor Description OrderSpec(Name property, boolean ascending)
Deprecated.useOrderSpec(Path, boolean)
instead.OrderSpec(Path property, boolean ascending)
Creates a newOrderSpec
forproperty
.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(Object obj)
Returnstrue
ifthis
order spec is equal toobj
String
getFunction()
Name
getProperty()
Deprecated.usegetPropertyPath()
instead.Path
getPropertyPath()
Returns the relative path of the property.boolean
isAscending()
Iftrue
the property is ordered ascending, otherwise descending.void
setAscending(boolean ascending)
Sets the new value for the ascending property.void
setFunction(String name)
Set a new value for a functionvoid
setPath(Path path)
Set a new value for the path
-
-
-
Constructor Detail
-
OrderSpec
public OrderSpec(Name property, boolean ascending)
Deprecated.useOrderSpec(Path, boolean)
instead.Creates a newOrderSpec
forproperty
.- Parameters:
property
- the name of the property.ascending
- iftrue
the property is ordered ascending, otherwise descending.
-
OrderSpec
public OrderSpec(Path property, boolean ascending)
Creates a newOrderSpec
forproperty
.- Parameters:
property
- the relative path of the property.ascending
- iftrue
the property is ordered ascending, otherwise descending.
-
-
Method Detail
-
getProperty
public Name getProperty()
Deprecated.usegetPropertyPath()
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()
Iftrue
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
-
-