com.clusterpoint.api.request
Class CPSListFacetsRequest

java.lang.Object
  extended by com.clusterpoint.api.CPSRequest
      extended by com.clusterpoint.api.request.CPSListFacetsRequest

public class CPSListFacetsRequest
extends CPSRequest

The CPSListFacetsRequest class is a wrapper for the CPSRequest class for the list-facets command

See Also:
CPSListFacetsResponse

Field Summary
 
Fields inherited from class com.clusterpoint.api.CPSRequest
CPSREQUEST_TYPE_AUTO, CPSREQUEST_TYPE_CLUSTER, CPSREQUEST_TYPE_SINGLE
 
Constructor Summary
CPSListFacetsRequest()
          Constructs an instance of the CPSListFacetsRequest class.
CPSListFacetsRequest(java.lang.String path)
          Constructs an instance of the CPSListFacetsRequest class.
CPSListFacetsRequest(java.lang.String[] paths)
          Constructs an instance of the CPSListFacetsRequest class.
 
Method Summary
 void setPaths(java.lang.String path)
          Set path for facet for which values will be returned
 void setPaths(java.lang.String[] path)
          Set array of paths for facets for which values will be returned
 
Methods inherited from class com.clusterpoint.api.CPSRequest
get_requestTypeString, getCommand, getRequestID, getRequestType, getRequestXml, setParam, setParam, setRequestID, setRequestType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CPSListFacetsRequest

public CPSListFacetsRequest()
                     throws java.lang.Exception
Constructs an instance of the CPSListFacetsRequest class.

Throws:
java.lang.Exception

CPSListFacetsRequest

public CPSListFacetsRequest(java.lang.String[] paths)
                     throws java.lang.Exception
Constructs an instance of the CPSListFacetsRequest class.

Parameters:
paths - an array of paths to list the facet terms from
Throws:
java.lang.Exception

CPSListFacetsRequest

public CPSListFacetsRequest(java.lang.String path)
                     throws java.lang.Exception
Constructs an instance of the CPSListFacetsRequest class.

Parameters:
path - facet path to list the facet terms from
Throws:
java.lang.Exception
Method Detail

setPaths

public void setPaths(java.lang.String path)
              throws java.lang.Exception
Set path for facet for which values will be returned

Parameters:
path - facet path to list the facet terms from
Throws:
java.lang.Exception

setPaths

public void setPaths(java.lang.String[] path)
              throws java.lang.Exception
Set array of paths for facets for which values will be returned

Parameters:
path - facet path to list the facet terms from
Throws:
java.lang.Exception