com.exalead.mercury.mami.search.v20

Class SearchAPIConfig

java.lang.Object

com.exalead.mercury.mami.search.v20.SearchAPIConfig

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Command>	command
java.lang.String	extraClassPath
java.lang.String	name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SearchAPIConfig.
static SearchAPIConfig	fromString(java.lang.String s) String representation of this SearchAPIConfig.
java.util.List<Command>	getCommand()
java.util.Map<java.lang.String,Command>	getCommandAsMap() Get the map of Command, indexed by base
Command	getCommandByBase(java.lang.String _lookup) Get the Command for which the base matches _lookup
java.lang.String	getExtraClassPath() Extra classpath for the web application. Comma or semicolon separated path of filenames or URLs pointing to directories or jar files.
java.lang.String	getName() Name of this API config
SearchAPIConfig	makeCopy() Creates and returns a deep copy of this SearchAPIConfig.
static SearchAPIConfig	readFrom(java.io.InputStream is) Read this SearchAPIConfig from an XML fragment.
boolean	removeCommandByBase(java.lang.String _lookup) Removes the Command for which the base matches _lookup
void	setExtraClassPath(java.lang.String extraClassPath) Extra classpath for the web application. Comma or semicolon separated path of filenames or URLs pointing to directories or jar files.
void	setName(java.lang.String name) Name of this API config
java.lang.String	toString() String representation of this SearchAPIConfig.
SearchAPIConfig	withCommand(java.util.Collection<Command> __values)
SearchAPIConfig	withCommand(Command... __values)
SearchAPIConfig	withExtraClassPath(java.lang.String extraClassPath)
SearchAPIConfig	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this SearchAPIConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

command

public java.util.List<Command> command

name

public java.lang.String name

extraClassPath

public java.lang.String extraClassPath

Constructor Detail

SearchAPIConfig

public SearchAPIConfig()

SearchAPIConfig

public SearchAPIConfig(SearchAPIConfig o)

Copy constructor

Method Detail

getCommand

public java.util.List<Command> getCommand()

getCommandByBase

public Command getCommandByBase(java.lang.String _lookup)

Get the Command for which the base matches _lookup

Returns:

null if no matching Command is found

getCommandAsMap

public java.util.Map<java.lang.String,Command> getCommandAsMap()

Get the map of Command, indexed by base

removeCommandByBase

public boolean removeCommandByBase(java.lang.String _lookup)

Removes the Command for which the base matches _lookup

Returns:

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

withCommand

public SearchAPIConfig withCommand(Command... __values)

withCommand

public SearchAPIConfig withCommand(java.util.Collection<Command> __values)

setName

public void setName(java.lang.String name)

Name of this API config

getName

public java.lang.String getName()

Name of this API config

withName

public SearchAPIConfig withName(java.lang.String name)

setExtraClassPath

public void setExtraClassPath(java.lang.String extraClassPath)

Extra classpath for the web application.
Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.
Used for JDBC for reporting and custom dependencies.

getExtraClassPath

public java.lang.String getExtraClassPath()

Extra classpath for the web application.
Comma or semicolon separated path of filenames or URLs pointing to directories or jar files. Directories should end with '/'.
Used for JDBC for reporting and custom dependencies.

withExtraClassPath

public SearchAPIConfig withExtraClassPath(java.lang.String extraClassPath)

makeCopy

public SearchAPIConfig makeCopy()

Creates and returns a deep copy of this SearchAPIConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SearchAPIConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SearchAPIConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this SearchAPIConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException