|
|||||||||
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.LookupList
public class LookupList
LookupList
instances represent a list of expressions
used to uniquely identify a record in a table (foreign or
local). These lookup expressions are objects of type Expr
.
Lookup expressions provide the ability to refer to values in
record sets that have been previously computed. Lookups can only
refer to record sets that were grouped and the
LookupList
must match the GroupBy
fields of
the lookup record set. A lookup expression maps a record in the
current statement's record set to a record in the lookup record
set. A LookupList
should therefore contain the same
number of expressions as the size of the GroupByList
of the
table it is used to key into.
Field Summary |
---|
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
LookupList()
Constructs an empty LookupList . |
Method Summary | |
---|---|
void |
add(int index,
Object obj)
Inserts a lookup expression object at position index . |
Object |
get(int index)
Gets the lookup expression at position index . |
Object |
remove(int index)
Removes the lookup expression element at the specified position in this list. |
Object |
set(int index,
Object obj)
Replaces the lookup expression object at position index
with the the lookup expression object specified by obj . |
int |
size()
Returns the number of lookup expressions in this LookupList . |
String |
toString()
Returns the string form of this LookupList . |
String |
toWire()
Returns the wire format of this LookupList . |
void |
validateSyntax()
Validates the syntax of this LookupList . |
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 LookupList()
LookupList
.
Method Detail |
---|
public Object get(int index)
index
.
The lookup expression must be of type Expr
.
get
in interface List
get
in class AbstractList
index
- offset of the desired lookup expression.
Expr
object) at position index
.
IndexOutOfBoundsException
- if index
is out of range.public int size()
LookupList
.
size
in interface Collection
size
in interface List
size
in class AbstractCollection
public Object set(int index, Object obj)
index
with the the lookup expression object specified by obj
.
set
in interface List
set
in class AbstractList
index
- offset of the Select
object to replace.obj
- the Select
object to store.
index
.
IndexOutOfBoundsException
- if index
is out of range.public void add(int index, Object obj)
index
.
Shifts the element currently at that position (if any) and
any subsequent elements to the right (adds one to their indices).
add
in interface List
add
in class AbstractList
index
- offset at which the lookup expression object is to be inserted.obj
- the lookup expression object to be inserted.
IndexOutOfBoundsException
- if index
is out of range.public Object remove(int index)
From
.
remove
in interface List
remove
in class AbstractList
index
- offset of element.
index
.
IndexOutOfBoundsException
- If the index is out of range.public String toString()
LookupList
. These are of the format:
expression1, expression2...where expression is the string form of a lookup expression.
toString
in interface QueryNode
toString
in class AbstractCollection
LookupList
in the specified format.public String toWire()
LookupList
. This method is not
intended for public use because the wire format is subject to change.
toWire
in interface QueryNode
LookupList
.public void validateSyntax() throws SyntaxException
LookupList
.
A LookupList
is valid if all of its expressions are themselves
valid. Note that a LookupList
with no elements is syntactically 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 |