com.exalead.mercury.mami.search.v20

Class MetaDescList

java.lang.Object

com.exalead.mercury.mami.search.v20.MetaDescList

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	logic
java.util.List<MetaDesc>	metaDesc

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this MetaDescList.
static MetaDescList	fromString(java.lang.String s) String representation of this MetaDescList.
java.lang.String	getLogic() Search logic for which this list is valid.
java.util.List<MetaDesc>	getMetaDesc() The list of valid metas in this introspection query.
java.util.Map<java.lang.String,MetaDesc>	getMetaDescAsMap() Get the map of MetaDesc, indexed by name
MetaDesc	getMetaDescByName(java.lang.String _lookup) Get the MetaDesc for which the name matches _lookup
MetaDescList	makeCopy() Creates and returns a deep copy of this MetaDescList.
static MetaDescList	readFrom(java.io.InputStream is) Read this MetaDescList from an XML fragment.
boolean	removeMetaDescByName(java.lang.String _lookup) Removes the MetaDesc for which the name matches _lookup
void	setLogic(java.lang.String logic) Search logic for which this list is valid.
java.lang.String	toString() String representation of this MetaDescList.
MetaDescList	withLogic(java.lang.String logic)
MetaDescList	withMetaDesc(java.util.Collection<MetaDesc> __values)
MetaDescList	withMetaDesc(MetaDesc... __values) The list of valid metas in this introspection query.
void	writeTo(java.io.OutputStream os) Write this MetaDescList 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

metaDesc

public java.util.List<MetaDesc> metaDesc

Constructor Detail

MetaDescList

public MetaDescList()

MetaDescList

public MetaDescList(MetaDescList o)

Copy constructor

Method Detail

setLogic

public void setLogic(java.lang.String logic)

Search logic for which this list is valid.

getLogic

public java.lang.String getLogic()

Search logic for which this list is valid.

withLogic

public MetaDescList withLogic(java.lang.String logic)

getMetaDesc

public java.util.List<MetaDesc> getMetaDesc()

The list of valid metas in this introspection query.

getMetaDescByName

public MetaDesc getMetaDescByName(java.lang.String _lookup)

Get the MetaDesc for which the name matches _lookup

Returns:

null if no matching MetaDesc is found

getMetaDescAsMap

public java.util.Map<java.lang.String,MetaDesc> getMetaDescAsMap()

Get the map of MetaDesc, indexed by name

removeMetaDescByName

public boolean removeMetaDescByName(java.lang.String _lookup)

Removes the MetaDesc for which the name matches _lookup

Returns:

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

withMetaDesc

public MetaDescList withMetaDesc(MetaDesc... __values)

The list of valid metas in this introspection query.

withMetaDesc

public MetaDescList withMetaDesc(java.util.Collection<MetaDesc> __values)

makeCopy

public MetaDescList makeCopy()

Creates and returns a deep copy of this MetaDescList.

readFrom

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

Read this MetaDescList 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 MetaDescList as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MetaDescList.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MetaDescList.

Overrides:

toString in class java.lang.Object

check

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

Checks this MetaDescList.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException