|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.repository.search.refinement.FacetTrail
public class FacetTrail
This is a bean class that holds details about the current facet trail. It provides methods to retrieve the facet trail in different ways: - In the order that the facet values were navigated - Facet values are grouped by facet, each facet ordered according to when the first of its values was navigated
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected java.lang.String |
mAddFacetParameterName
|
protected RepositoryItem |
mCurrentSortOption
|
protected FacetHolder[] |
mFacetTrailGroupedByFacet
|
protected FacetValue[] |
mFacetValues
|
protected RefinementConfiguration |
mRefineConfig
|
protected java.lang.String |
mRemoveAllFacetsParameterName
|
protected java.lang.String |
mRemoveFacetParameterName
|
protected java.lang.String |
mRemoveFacetTypeParameterName
|
protected java.lang.String |
mSeparator
|
protected java.lang.String |
mSortByParameterName
|
protected java.lang.String |
mTrailParameterName
|
Constructor Summary | |
---|---|
FacetTrail(RefinementConfiguration pRefineConfig,
FacetValue[] pFacetValues,
RepositoryItem pCurrentSortOptionItem)
Constructor method. |
Method Summary | |
---|---|
boolean |
facetExistsInTrail(Facet pFacet)
Checks whether a facet exists in the facet trail |
java.lang.String |
getAddFacetParameterName()
|
RepositoryItem |
getCurrentSortOption()
Gets the currently selected sort option |
FacetHolder[] |
getFacetTrailGroupedByFacet()
|
FacetValue[] |
getFacetValues()
Getter for the facet trail by navigation order |
RefinementConfiguration |
getRefineConfig()
|
java.lang.String |
getRemoveAllFacetsParameterName()
|
java.lang.String |
getRemoveFacetParameterName()
|
java.lang.String |
getRemoveFacetTypeParameterName()
|
java.lang.String |
getSeparator()
|
java.lang.String |
getSortByParameterName()
|
java.lang.String |
getTrailParameterName()
|
java.lang.String |
getTrailString()
Generates a String representation of the facet trail that can be used in a URL parameter |
protected FacetHolder[] |
groupFacetTrailByFacet()
Gets the facet trail grouped by facet |
boolean |
hasSearchFacets()
Utility method to check whether the facet trail has any search facets. |
void |
setAddFacetParameterName(java.lang.String pAddFacetParameterName)
|
void |
setCurrentSortOption(RepositoryItem pCurrentSortOption)
Set the currently selected sort option |
void |
setFacetTrailGroupedByFacet(FacetHolder[] pFacetTrailGroupedByFacet)
|
void |
setFacetValues(FacetValue[] pFacetValues)
Setter for the facet trail by navigation order |
void |
setRefineConfig(RefinementConfiguration pRefineConfig)
|
void |
setRemoveAllFacetsParameterName(java.lang.String pRemoveAllFacetsParameterName)
|
void |
setRemoveFacetParameterName(java.lang.String pRemoveFacetParameterName)
|
void |
setRemoveFacetTypeParameterName(java.lang.String pRemoveFacetTypeParameterName)
|
void |
setSeparator(java.lang.String pSeparator)
|
void |
setSortByParameterName(java.lang.String pSortByParameterName)
|
void |
setTrailParameterName(java.lang.String pTrailParameterName)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected RefinementConfiguration mRefineConfig
protected FacetValue[] mFacetValues
protected RepositoryItem mCurrentSortOption
protected java.lang.String mSeparator
protected java.lang.String mTrailParameterName
protected java.lang.String mSortByParameterName
protected java.lang.String mAddFacetParameterName
protected java.lang.String mRemoveFacetParameterName
protected java.lang.String mRemoveAllFacetsParameterName
protected java.lang.String mRemoveFacetTypeParameterName
protected FacetHolder[] mFacetTrailGroupedByFacet
Constructor Detail |
---|
public FacetTrail(RefinementConfiguration pRefineConfig, FacetValue[] pFacetValues, RepositoryItem pCurrentSortOptionItem) throws FacetException
pRefineConfig
- The refinement configuration to use for queries and to
the set of sort options available.pFacetValues
- Array of facet values in the order that they were
navigated.pCurrentSortOption
- The current sort option repository itempSeparator
- The separator sequence used to separate facet values
in a facet trail URL parameter.pSortString
- String id to use to prefix the current sort option
FacetException
- for problems creating a RefinementSortOptionMethod Detail |
---|
public RefinementConfiguration getRefineConfig()
public void setRefineConfig(RefinementConfiguration pRefineConfig)
public FacetValue[] getFacetValues()
public void setFacetValues(FacetValue[] pFacetValues)
pFacetValues
- An array of FacetValue objects, each entry in the array
representing a facet value that was navigated. Elements in the array
are ordered according to the order they were navigated.public RepositoryItem getCurrentSortOption()
public void setCurrentSortOption(RepositoryItem pCurrentSortOption)
pSortOption
- The RepositoryItem sort option to set.public java.lang.String getSeparator()
public void setSeparator(java.lang.String pSeparator)
public java.lang.String getTrailParameterName()
public void setTrailParameterName(java.lang.String pTrailParameterName)
public java.lang.String getSortByParameterName()
public void setSortByParameterName(java.lang.String pSortByParameterName)
public java.lang.String getAddFacetParameterName()
public void setAddFacetParameterName(java.lang.String pAddFacetParameterName)
public java.lang.String getRemoveFacetParameterName()
public void setRemoveFacetParameterName(java.lang.String pRemoveFacetParameterName)
public java.lang.String getRemoveAllFacetsParameterName()
public void setRemoveAllFacetsParameterName(java.lang.String pRemoveAllFacetsParameterName)
public java.lang.String getRemoveFacetTypeParameterName()
public void setRemoveFacetTypeParameterName(java.lang.String pRemoveFacetTypeParameterName)
public FacetHolder[] getFacetTrailGroupedByFacet()
public void setFacetTrailGroupedByFacet(FacetHolder[] pFacetTrailGroupedByFacet)
protected FacetHolder[] groupFacetTrailByFacet()
public java.lang.String getTrailString()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean hasSearchFacets()
true
if the facet trail contains one or more search facets,
false
otherwise.public boolean facetExistsInTrail(Facet pFacet)
pFacet
- The facet to check
true
if the facet occurs in the facet trail, false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |