com.exalead.mercury.mami.search.v20

Class CreateSuggestXMLFile

java.lang.Object

com.exalead.mercury.mami.search.v20.CreateSuggestXMLFile

All Implemented Interfaces:

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

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

Output the suggest data to an XML file.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	outputFile
java.lang.String	suggestName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CreateSuggestXMLFile.
static CreateSuggestXMLFile	fromString(java.lang.String s) String representation of this CreateSuggestXMLFile.
java.lang.String	getOutputFile() Filename of the output.
java.lang.String	getSuggestName() Name of the suggest to create.
CreateSuggestXMLFile	makeCopy() Creates and returns a deep copy of this CreateSuggestXMLFile.
static CreateSuggestXMLFile	readFrom(java.io.InputStream is) Read this CreateSuggestXMLFile from an XML fragment.
void	setOutputFile(java.lang.String outputFile) Filename of the output.
void	setSuggestName(java.lang.String suggestName) Name of the suggest to create.
java.lang.String	toString() String representation of this CreateSuggestXMLFile.
CreateSuggestXMLFile	withOutputFile(java.lang.String outputFile)
CreateSuggestXMLFile	withSuggestName(java.lang.String suggestName)
void	writeTo(java.io.OutputStream os) Write this CreateSuggestXMLFile as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

suggestName

public java.lang.String suggestName

outputFile

public java.lang.String outputFile

Constructor Detail

CreateSuggestXMLFile

public CreateSuggestXMLFile()

CreateSuggestXMLFile

public CreateSuggestXMLFile(CreateSuggestXMLFile o)

Copy constructor

Method Detail

setSuggestName

public void setSuggestName(java.lang.String suggestName)

Name of the suggest to create.

getSuggestName

public java.lang.String getSuggestName()

Name of the suggest to create.

withSuggestName

public CreateSuggestXMLFile withSuggestName(java.lang.String suggestName)

setOutputFile

public void setOutputFile(java.lang.String outputFile)

Filename of the output.

getOutputFile

public java.lang.String getOutputFile()

Filename of the output.

withOutputFile

public CreateSuggestXMLFile withOutputFile(java.lang.String outputFile)

makeCopy

public CreateSuggestXMLFile makeCopy()

Creates and returns a deep copy of this CreateSuggestXMLFile.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CreateSuggestXMLFile.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CreateSuggestXMLFile.

Overrides:

toString in class java.lang.Object

check

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

Checks this CreateSuggestXMLFile.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException