|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.ENEQueryToolkit
public class ENEQueryToolkit
ENEQueryToolkit
provides static methods for managing the value of
the primary URL query parameter in a navigation query. This parameter specifies
the list of refinement dimensions that were used to generate the current
query results. Managing the parameter's value allows you to maintain application state.
With ENEQueryToolkit
, you can update the list of refinement dimensions
to reflect the user's latest refinement selection. That selection may require the
addition of a new refinement dimension, the removal of a dimension, or the
substitution of one dimension ID for another (as in the case where the user
selects a refinement from a nested dimension hierarchy).
Method Summary | |
---|---|
static boolean |
isImplicitRefinement(Dimension dim,
DimVal refinement)
Determines if a dimension value refinement is an implicit refinement within the context of a given dimension. |
static DimValIdList |
removeDescriptor(Navigation n,
DimVal descriptor)
Generates the navigation descriptors of the ENEQuery
after removing a descriptor. |
static DimValIdList |
selectAncestor(Navigation n,
DimVal ancestor,
DimVal descriptor)
Generates the navigation descriptors of the ENEQuery
for a selected ancestor. |
static DimValIdList |
selectRefinement(Navigation n,
DimVal refinement)
Generates the navigation descriptors of the ENEQuery
for a selected refinement. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static DimValIdList selectRefinement(Navigation n, DimVal refinement)
ENEQuery
for a selected refinement. This method adds a refinement value to
the set of navigation descriptors already existing in
a Navigation
object and generates a new set of navigation
values for the ENEQuery
. In general, new refinements
are placed at the end of the descriptor list. Existing
descriptors that are ancestors of the refinements are removed.
n
- the current Navigation
objectrefinement
- the refinement dimension value (DimVal
object)
that will be used to reduce the current record set
DimValIdList
object containing the IDs of the
new navigation query descriptors after the addition of the
specified refinement value to the existing set of navigation
descriptors in the Navigation
object.public static DimValIdList selectAncestor(Navigation n, DimVal ancestor, DimVal descriptor)
ENEQuery
for a selected ancestor. This method replaces the specified navigation
descriptor (the descriptor
parameter) with the ancestor
dimension value (the ancestor
parameter), and generates
a new set of navigation values for the ENEQuery
. The order
of the descriptors remains the same as the order in the current
Navigation
object. However, the specified ancestor is
substituted for the specified descriptor.
n
- the current Navigation
objectancestor
- the ancestor (a DimVal
object) which will
be used to generate new navigation valuesdescriptor
- the descriptor (a DimVal
object) which
will be replaced with its ancestor
DimValIdList
object containing the IDs of the
new navigation query descriptors after the current navigation
descriptor is replaced with its ancestor.public static DimValIdList removeDescriptor(Navigation n, DimVal descriptor)
ENEQuery
after removing a descriptor. This method removes the specified
navigation descriptor (the descriptor
parameter)
from the set of descriptors in the Navigation
object
and generates a new set of navigation values for the ENEQuery
.
The order of the descriptors in the new navigation query remains
the same as the order in the current Navigation
object (specified by the n
parameter), with the
descriptor removed. Ancestors of the descriptor do not remain
after the descriptor has been removed.
n
- the current Navigation
objectdescriptor
- the descriptor (a DimVal
object) which
will be removed
DimValIdList
object containing the IDs of the
new navigation query descriptors after the removal of the
specified descriptor.public static boolean isImplicitRefinement(Dimension dim, DimVal refinement)
dim
- the dimension (a Dimension
object) in
which the given refinement should be checkedrefinement
- the refinement (a DimVal
object) which
will be checked
true
if refinement
is an
implicit refinement within the dimension dim
,
or false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |