com.exalead.mercury.mami.search.v20

Class SearchTargetList

java.lang.Object

exa.bee.config.Versioned

com.exalead.mercury.mami.search.v20.SearchTargetList

All Implemented Interfaces:

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

public class SearchTargetList
extends exa.bee.config.Versioned
implements com.exalead.util.Checkable, java.io.Serializable

Returns a list of Search Target

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<SearchTarget>	searchTarget

Fields inherited from class exa.bee.config.Versioned

version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SearchTargetList.
static SearchTargetList	fromString(java.lang.String s) String representation of this SearchTargetList.
java.util.List<SearchTarget>	getSearchTarget() List of search target
java.util.Map<java.lang.String,SearchTarget>	getSearchTargetAsMap() Get the map of SearchTarget, indexed by targetName
SearchTarget	getSearchTargetByTargetName(java.lang.String _lookup) Get the SearchTarget for which the targetName matches _lookup
SearchTargetList	makeCopy() Creates and returns a deep copy of this SearchTargetList.
static SearchTargetList	readFrom(java.io.InputStream is) Read this SearchTargetList from an XML fragment.
boolean	removeSearchTargetByTargetName(java.lang.String _lookup) Removes the SearchTarget for which the targetName matches _lookup
java.lang.String	toString() String representation of this SearchTargetList.
SearchTargetList	withSearchTarget(java.util.Collection<SearchTarget> __values)
SearchTargetList	withSearchTarget(SearchTarget... __values) List of search target
SearchTargetList	withVersion(long version)
SearchTargetList	withVersion(java.lang.Long version)
void	writeTo(java.io.OutputStream os) Write this SearchTargetList as an XML fragment

Methods inherited from class exa.bee.config.Versioned

clone, getVersion, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

searchTarget

public java.util.List<SearchTarget> searchTarget

Constructor Detail

SearchTargetList

public SearchTargetList()

SearchTargetList

public SearchTargetList(SearchTargetList o)

Copy constructor

Method Detail

withVersion

public SearchTargetList withVersion(long version)

Overrides:

withVersion in class exa.bee.config.Versioned

withVersion

public SearchTargetList withVersion(java.lang.Long version)

Overrides:

withVersion in class exa.bee.config.Versioned

getSearchTarget

public java.util.List<SearchTarget> getSearchTarget()

List of search target

getSearchTargetByTargetName

public SearchTarget getSearchTargetByTargetName(java.lang.String _lookup)

Get the SearchTarget for which the targetName matches _lookup

Returns:

null if no matching SearchTarget is found

getSearchTargetAsMap

public java.util.Map<java.lang.String,SearchTarget> getSearchTargetAsMap()

Get the map of SearchTarget, indexed by targetName

removeSearchTargetByTargetName

public boolean removeSearchTargetByTargetName(java.lang.String _lookup)

Removes the SearchTarget for which the targetName matches _lookup

Returns:

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

withSearchTarget

public SearchTargetList withSearchTarget(SearchTarget... __values)

List of search target

withSearchTarget

public SearchTargetList withSearchTarget(java.util.Collection<SearchTarget> __values)

makeCopy

public SearchTargetList makeCopy()

Creates and returns a deep copy of this SearchTargetList.

Overrides:

makeCopy in class exa.bee.config.Versioned

readFrom

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

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

Overrides:

writeTo in class exa.bee.config.Versioned

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SearchTargetList.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SearchTargetList.

Overrides:

toString in class exa.bee.config.Versioned

check

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

Checks this SearchTargetList.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class exa.bee.config.Versioned

Throws:

com.exalead.util.TypedException