|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.repository.search.refinement.FacetValue atg.repository.search.refinement.RangeFacetValue
public class RangeFacetValue
An extension to the FacetValue class which represents a range value
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
DEFAULT_LAST_INDICATOR
String constant for the default last range value indicator |
static java.lang.String |
DEFAULT_RANGE_SEPARATOR
String constant for splitting range values |
static java.lang.String |
DEFAULT_VALUEINDICATOR_SEPARATOR
String constant for the default value indicator separator |
protected java.lang.String |
mIndicatorSeparator
Separator used to separate the range value from the last range value indicator. |
protected java.lang.String |
mLastIndicator
Indicator string used to indicate that the range value is the last one. |
protected boolean |
mLastRangeValue
Indicates whether this range value is the last one. |
Fields inherited from class atg.repository.search.refinement.FacetValue |
---|
DEFAULT_IDVALUE_SEPARATOR, mFacet, mMatchingDocsCount, mRefinementValue, mScore, mSeparator, mValue |
Constructor Summary | |
---|---|
RangeFacetValue(Facet pFacet,
java.lang.Object pValue,
long pMatchingDocsCount,
int pScore,
boolean pIsLastRangeValue)
Constructor method |
|
RangeFacetValue(Facet pFacet,
java.lang.Object pValue,
java.lang.String pSeparator,
boolean pIsLastRangeValue,
java.lang.String pLastIndicator,
java.lang.String pIndicatorSeparator)
Constructor method. |
|
RangeFacetValue(Facet pFacet,
RefinementValue pRefinementValue,
int pScore,
boolean pIsLastRangeValue)
Constructor method |
Method Summary | |
---|---|
java.lang.Object |
clone()
Override clone to copy this object |
java.lang.String |
getIndicatorSeparator()
Getter method for indicator separator |
java.lang.String |
getLastIndicator()
Getter method for last indicator |
java.lang.String |
getRangeEnd()
Gets the end value of the range. |
java.lang.String |
getRangeStart()
Gets the start value of the range |
java.lang.String |
getTrailString()
Returns a String representation of the facet value intended for use in a URL trail parameter. |
boolean |
isLastRangeValue()
Indicates whether this range value is the last one in the range |
void |
setIndicatorSeparator(java.lang.String pIndicatorSeparator)
Setter method for indicator separator |
void |
setLastIndicator(java.lang.String pLastIndicator)
Setter method for last indicator |
void |
setLastRangeValue(boolean pIsLastRangeValue)
Sets whether this is the last range value |
Methods inherited from class atg.repository.search.refinement.FacetValue |
---|
equals, getDebug, getFacet, getMatchingDocsCount, getRefinementValue, getScore, getSeparator, getValue, hashCode, setFacet, setMatchingDocsCount, setRefinementValue, setScore, setSeparator, setValue, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String DEFAULT_LAST_INDICATOR
public static final java.lang.String DEFAULT_VALUEINDICATOR_SEPARATOR
public static final java.lang.String DEFAULT_RANGE_SEPARATOR
protected boolean mLastRangeValue
protected java.lang.String mIndicatorSeparator
protected java.lang.String mLastIndicator
Constructor Detail |
---|
public RangeFacetValue(Facet pFacet, java.lang.Object pValue, long pMatchingDocsCount, int pScore, boolean pIsLastRangeValue)
pFacet
- Facet referencepValue
- Object valuepMatchingDocsCount
- The number of matching documents for this facet value.pScore
- The relevancy of this facet valuepIsLastRangeValue
- Indicates whether this is the last range valuepublic RangeFacetValue(Facet pFacet, RefinementValue pRefinementValue, int pScore, boolean pIsLastRangeValue)
pFacet
- Facet referencepRefinementValue
- RefinementValue from responsepScore
- The relevancy of this facet valuepIsLastRangeValue
- Indicates whether this is the last range valuepublic RangeFacetValue(Facet pFacet, java.lang.Object pValue, java.lang.String pSeparator, boolean pIsLastRangeValue, java.lang.String pLastIndicator, java.lang.String pIndicatorSeparator)
pFacet
- Facet referencepValue
- Object valuepSeparator
- String separatorpIsLastRangeValue
- Indicates whether this is the last range valuepLastIndicator
- Last indicator stringpindicatorSeparator
- Separator used to separate value from last range value indicatorMethod Detail |
---|
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class FacetValue
java.lang.CloneNotSupportedException
Object.clone()
public boolean isLastRangeValue()
public void setLastRangeValue(boolean pIsLastRangeValue)
pIsLastRangeValue
- The value to set.public java.lang.String getRangeStart()
public java.lang.String getRangeEnd()
public java.lang.String getIndicatorSeparator()
public void setIndicatorSeparator(java.lang.String pIndicatorSeparator)
pIndicatorSeparator
- String indicator separatorpublic java.lang.String getLastIndicator()
public void setLastIndicator(java.lang.String pLastIndicator)
pLastIndicator
- String last indicatorpublic java.lang.String getTrailString()
getTrailString
in class FacetValue
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |