|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractCollection<E> java.util.AbstractList com.endeca.navigation.analytics.OrderByList
public class OrderByList
An OrderByList
is a list of OrderBy
instances.
Unlike a GroupByList
, an OrderByList
may not be
empty, because an empty list does not imply a repeatable order.
Field Summary |
---|
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
OrderByList()
Constructs a new, empy OrderByList . |
Method Summary | |
---|---|
void |
add(int index,
Object obj)
Inserts an OrderBy object at position index . |
Object |
get(int index)
Gets the OrderBy object at position index . |
Object |
remove(int index)
Removes the OrderBy at the specified position in this list. |
Object |
set(int index,
Object obj)
Replaces the OrderBy object at position index
with the the OrderBy object specified by obj . |
int |
size()
Returns the number of OrderBy expressions in this OrderByList . |
String |
toString()
Returns the string form of this OrderByList . |
String |
toWire()
Returns the wire format of this OrderByList . |
void |
validateSyntax()
Validates the syntax of this OrderByList . |
Methods inherited from class java.util.AbstractList |
---|
add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList |
Methods inherited from class java.util.AbstractCollection |
---|
addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.List |
---|
add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, retainAll, subList, toArray, toArray |
Constructor Detail |
---|
public OrderByList()
OrderByList
.
Method Detail |
---|
public Object get(int index)
OrderBy
object at position index
.
get
in interface List
get
in class AbstractList
index
- offset of the desired OrderBy
object.
OrderBy
object at position index
.
IndexOutOfBoundsException
- if index
is out of range.public int size()
OrderBy
expressions in this OrderByList
.
size
in interface Collection
size
in interface List
size
in class AbstractCollection
OrderBy
elements in the list.public Object set(int index, Object obj)
OrderBy
object at position index
with the the OrderBy
object specified by obj
.
set
in interface List
set
in class AbstractList
index
- offset of the OrderBy
object to replace.obj
- the OrderBy
object to store.
OrderBy
object previously at position index
.
IndexOutOfBoundsException
- if index
is out of range.
IllegalArgumentException
- if obj
is not an OrderBy
.public void add(int index, Object obj)
OrderBy
object at position index
.
Shifts the OrderBy
element currently at that position (if any) and
any subsequent OrderBy
elements to the right (adds one to their indices).
add
in interface List
add
in class AbstractList
index
- offset at which the OrderBy
is to be inserted.obj
- the OrderBy
to be inserted.
IndexOutOfBoundsException
- if index
is out of range.
IllegalArgumentException
- if obj
is not an OrderBy
.public Object remove(int index)
OrderBy
at the specified position in this list.
Shifts any subsequent OrderBy
elements to the left (subtracts one from
their indices). Returns the OrderBy
that was removed from the list.
remove
in interface List
remove
in class AbstractList
index
- offset of the OrderBy
to be removed.
OrderBy
previously at position index
.
IndexOutOfBoundsException
- if index
is out of range.public String toString()
OrderByList
. These are of the format:
ORDER BY key-sort-name1 sortdir, key-sort-name2 sortdir ...where sortdir is either ASC or DESC. For example:
ORDER BY Total DESC
is returned if the sorting key is a property named Total
and a descending sort direction has been set.
toString
in interface QueryNode
toString
in class AbstractCollection
OrderByList
.public String toWire()
OrderByList
. This method is not
intended for public use because the wire format is subject to change.
toWire
in interface QueryNode
OrderByList
.public void validateSyntax() throws SyntaxException
OrderByList
.
An OrderByList
is valid if it is non-empty (must
contain at least one OrderBy
element) and all its
OrderBy
elements are themselves valid.
validateSyntax
in interface QueryNode
SyntaxException
- if the syntax requirements are not satisfied.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |