|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.repository.search.refinement.Facet atg.repository.search.refinement.RefinementFacet
public class RefinementFacet
Represents a refinement element that exists in the refinement repository. Extends the Facet class, providing a lazy lookup method to get the underlying repository item for a refinement element
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected FacetManager |
mFacetManager
|
protected java.lang.String |
mId
|
protected Refinement |
mRefinement
|
protected RefinementElement |
mRefinementElement
|
Constructor Summary | |
---|---|
RefinementFacet(Refinement pRefinement,
FacetManager pFacetManager)
Constructor method |
|
RefinementFacet(RepositoryItem pItem,
FacetManager pFacetManager)
Constructor method that can be used when we already have the repository item for the facet. |
|
RefinementFacet(java.lang.String pId,
FacetManager pFacetManager)
Constructor method |
Method Summary | |
---|---|
java.lang.String |
getDebug()
If this is not null then it returns the reason why the facet isn't valid in the response. |
FacetManager |
getFacetManager()
|
java.lang.String |
getId()
Gets the ID of the facet |
java.lang.String |
getLabel()
Gets the display name label for the facet |
Refinement |
getRefinement()
Getter for refinement |
RefinementElement |
getRefinementElement()
|
protected RefinementElement |
getRefinementElement(RepositoryItem pItem)
|
protected RepositoryItem |
getRepositoryItem()
|
protected void |
setFacetManager(FacetManager pFacetManager)
|
protected void |
setId(java.lang.String pId)
|
void |
setRefinement(Refinement pRefinement)
Setter for refinement |
protected void |
setRefinementElement(RefinementElement pRefinementElement)
|
Methods inherited from class atg.repository.search.refinement.Facet |
---|
equals, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected java.lang.String mId
protected RefinementElement mRefinementElement
protected FacetManager mFacetManager
protected Refinement mRefinement
Constructor Detail |
---|
public RefinementFacet(java.lang.String pId, FacetManager pFacetManager)
pId
- The ID of the refineElement RepositoryItempFacetManager
- The FacetManager instance used to query the repository.public RefinementFacet(Refinement pRefinement, FacetManager pFacetManager)
pRefinement
- The Refinement from a search response of the refineElementpFacetManager
- The FacetManager instance can be used to query the repository.public RefinementFacet(RepositoryItem pItem, FacetManager pFacetManager) throws FacetException
pItem
- refineElement Repository ItempFacetManager
- The FacetManager instance used to query the
repository.
FacetException
- for problems getting the RefinementElementMethod Detail |
---|
public java.lang.String getId()
Facet
getId
in class Facet
Gets the repository ID of the facet.
protected void setId(java.lang.String pId)
public FacetManager getFacetManager()
protected void setFacetManager(FacetManager pFacetManager)
public RefinementElement getRefinementElement() throws FacetException
FacetException
protected void setRefinementElement(RefinementElement pRefinementElement)
public java.lang.String getLabel() throws FacetException
Facet
getLabel
in class Facet
FacetException
- for problems getting the label.Gets the label for the facet
public void setRefinement(Refinement pRefinement)
pRefinement
- Refinementpublic Refinement getRefinement()
public java.lang.String getDebug()
getDebug
in class Facet
protected RepositoryItem getRepositoryItem() throws FacetException
FacetException
protected RefinementElement getRefinementElement(RepositoryItem pItem) throws FacetException
FacetException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |