com.exalead.mercury.mami.learning.v10

Class DocumentAnnotation

java.lang.Object

com.exalead.mercury.mami.learning.v10.DocumentAnnotation

All Implemented Interfaces:

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

public class DocumentAnnotation
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
static java.lang.String	DEFAULT_VALUE
java.lang.String	tag
java.lang.String	value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DocumentAnnotation.
static DocumentAnnotation	fromString(java.lang.String s) String representation of this DocumentAnnotation.
java.lang.String	getTag() This annotation should be one of the annotation output by the 'pipelineConfig' module.
java.lang.String	getValue() The associated value (optional)
DocumentAnnotation	makeCopy() Creates and returns a deep copy of this DocumentAnnotation.
static DocumentAnnotation	readFrom(java.io.InputStream is) Read this DocumentAnnotation from an XML fragment.
void	setTag(java.lang.String tag) This annotation should be one of the annotation output by the 'pipelineConfig' module.
void	setValue(java.lang.String value) The associated value (optional)
java.lang.String	toString() String representation of this DocumentAnnotation.
DocumentAnnotation	withTag(java.lang.String tag)
DocumentAnnotation	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this DocumentAnnotation as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

tag

public java.lang.String tag

value

public java.lang.String value

DEFAULT_VALUE

public static final java.lang.String DEFAULT_VALUE

See Also:

Constant Field Values

Constructor Detail

DocumentAnnotation

public DocumentAnnotation()

DocumentAnnotation

public DocumentAnnotation(DocumentAnnotation o)

Copy constructor

Method Detail

setTag

public void setTag(java.lang.String tag)

This annotation should be one of the annotation output by the 'pipelineConfig' module.

getTag

public java.lang.String getTag()

This annotation should be one of the annotation output by the 'pipelineConfig' module.

withTag

public DocumentAnnotation withTag(java.lang.String tag)

setValue

public void setValue(java.lang.String value)

The associated value (optional)

getValue

public java.lang.String getValue()

The associated value (optional)

withValue

public DocumentAnnotation withValue(java.lang.String value)

makeCopy

public DocumentAnnotation makeCopy()

Creates and returns a deep copy of this DocumentAnnotation.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DocumentAnnotation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DocumentAnnotation.

Overrides:

toString in class java.lang.Object

check

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

Checks this DocumentAnnotation.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException