|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.repository.search.refinement.FacetValue
public class FacetValue
This is a bean class that holds reference to a facet and one of its values.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
DEFAULT_IDVALUE_SEPARATOR
|
protected atg.repository.search.refinement.Facet |
mFacet
|
protected long |
mMatchingDocsCount
|
protected RefinementValue |
mRefinementValue
|
protected int |
mScore
The relevancy of this facet value. |
protected java.lang.String |
mSeparator
|
protected java.lang.Object |
mValue
|
Constructor Summary | |
---|---|
FacetValue(atg.repository.search.refinement.Facet pFacet,
java.lang.Object pValue,
long pMatchingDocsCount,
int pScore)
Constructor method |
|
FacetValue(atg.repository.search.refinement.Facet pFacet,
java.lang.Object pValue,
java.lang.String pSeparator)
Constructor method. |
|
FacetValue(atg.repository.search.refinement.Facet pFacet,
RefinementValue pRefineValue,
int pScore)
Constructor method |
Method Summary | |
---|---|
java.lang.Object |
clone()
Override clone to copy this object |
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getDebug()
If this is not null then it returns the reason why the facet value was excluded in the response. |
atg.repository.search.refinement.Facet |
getFacet()
|
long |
getMatchingDocsCount()
Getter for the count of matching documents for this facet value |
RefinementValue |
getRefinementValue()
Getter for RefinementValue from response |
int |
getScore()
|
java.lang.String |
getSeparator()
|
java.lang.String |
getTrailString()
Returns a String representation of the facet value intended for use in a URL trail parameter. |
java.lang.Object |
getValue()
|
int |
hashCode()
|
void |
setFacet(atg.repository.search.refinement.Facet pFacet)
|
void |
setMatchingDocsCount(long pMatchingDocsCount)
Setter for the count of matching documents for this facet value |
void |
setRefinementValue(RefinementValue pRefinementValue)
Setter for RefinementValue from response |
void |
setScore(int pScore)
|
void |
setSeparator(java.lang.String pSeparator)
|
void |
setValue(java.lang.Object pValue)
|
java.lang.String |
toString()
Returns a String representation of the facet value intended for use in a URL trail parameter. |
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_IDVALUE_SEPARATOR
protected atg.repository.search.refinement.Facet mFacet
protected RefinementValue mRefinementValue
protected java.lang.Object mValue
protected long mMatchingDocsCount
protected java.lang.String mSeparator
protected int mScore
Constructor Detail |
---|
public FacetValue(atg.repository.search.refinement.Facet pFacet, java.lang.Object pValue, long pMatchingDocsCount, int pScore)
pFacet
- Facet referencepValue
- Object valuepMatchingDocsCount
- The number of matching documents for this facet value.pScore
- The relevancy of this facet valuepublic FacetValue(atg.repository.search.refinement.Facet pFacet, RefinementValue pRefineValue, int pScore)
pFacet
- Facet referencepRefineValue
- RefinementValue referencepScore
- The relevancy of this facet valuepublic FacetValue(atg.repository.search.refinement.Facet pFacet, java.lang.Object pValue, java.lang.String pSeparator)
pFacet
- Facet referencepValue
- Object valuepSeparator
- String separatorMethod Detail |
---|
public atg.repository.search.refinement.Facet getFacet()
public void setFacet(atg.repository.search.refinement.Facet pFacet)
public RefinementValue getRefinementValue()
public void setRefinementValue(RefinementValue pRefinementValue)
pRefinementValue
- RefinementValuepublic java.lang.String getSeparator()
public void setSeparator(java.lang.String pSeparator)
public java.lang.Object getValue()
public void setValue(java.lang.Object pValue)
public long getMatchingDocsCount()
public void setMatchingDocsCount(long pMatchingDocsCount)
mMatchingDocsCount
- A long value >= 0.public int getScore()
public void setScore(int pScore)
pScore
- The relevancy to set.public java.lang.String getDebug()
public java.lang.String getTrailString()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
Object.clone()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |