com.exalead.mercury.mami.search.v20

Class FacetDescList

java.lang.Object

com.exalead.mercury.mami.search.v20.FacetDescList

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class FacetDescList
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Class returned by the search-api introspection method "/facets"

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<FacetDesc>	facetDesc
java.lang.String	logic

Constructor Summary

Constructors

Constructor and Description
FacetDescList()
FacetDescList(FacetDescList o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FacetDescList.
static FacetDescList	fromString(java.lang.String s) String representation of this FacetDescList.
java.util.List<FacetDesc>	getFacetDesc() The list of valid facets in this introspection query
java.util.Map<java.lang.String,FacetDesc>	getFacetDescAsMap() Get the map of FacetDesc, indexed by id
FacetDesc	getFacetDescById(java.lang.String _lookup) Get the FacetDesc for which the id matches _lookup
java.lang.String	getLogic() Logic for which this list is valid
FacetDescList	makeCopy() Creates and returns a deep copy of this FacetDescList.
static FacetDescList	readFrom(java.io.InputStream is) Read this FacetDescList from an XML fragment.
boolean	removeFacetDescById(java.lang.String _lookup) Removes the FacetDesc for which the id matches _lookup
void	setLogic(java.lang.String logic) Logic for which this list is valid
java.lang.String	toString() String representation of this FacetDescList.
FacetDescList	withFacetDesc(java.util.Collection<FacetDesc> __values)
FacetDescList	withFacetDesc(FacetDesc... __values) The list of valid facets in this introspection query
FacetDescList	withLogic(java.lang.String logic)
void	writeTo(java.io.OutputStream os) Write this FacetDescList as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logic

public java.lang.String logic

facetDesc

public java.util.List<FacetDesc> facetDesc

Constructor Detail

FacetDescList

public FacetDescList()

FacetDescList

public FacetDescList(FacetDescList o)

Copy constructor

Method Detail

setLogic

public void setLogic(java.lang.String logic)

Logic for which this list is valid

getLogic

public java.lang.String getLogic()

Logic for which this list is valid

withLogic

public FacetDescList withLogic(java.lang.String logic)

getFacetDesc

public java.util.List<FacetDesc> getFacetDesc()

The list of valid facets in this introspection query

getFacetDescById

public FacetDesc getFacetDescById(java.lang.String _lookup)

Get the FacetDesc for which the id matches _lookup

Returns:

null if no matching FacetDesc is found

getFacetDescAsMap

public java.util.Map<java.lang.String,FacetDesc> getFacetDescAsMap()

Get the map of FacetDesc, indexed by id

removeFacetDescById

public boolean removeFacetDescById(java.lang.String _lookup)

Removes the FacetDesc for which the id matches _lookup

Returns:

false if no matching FacetDesc is found, true if one was found

withFacetDesc

public FacetDescList withFacetDesc(FacetDesc... __values)

The list of valid facets in this introspection query

withFacetDesc

public FacetDescList withFacetDesc(java.util.Collection<FacetDesc> __values)

makeCopy

public FacetDescList makeCopy()

Creates and returns a deep copy of this FacetDescList.

readFrom

public static FacetDescList readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException

Read this FacetDescList from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this FacetDescList as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static FacetDescList fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException

String representation of this FacetDescList.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FacetDescList.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this FacetDescList.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException