com.exalead.indexing.analysis.v10

Class CoordinatesFormatter

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

com.exalead.indexing.analysis.v10.CoordinatesFormatter

All Implemented Interfaces:

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

public class CoordinatesFormatter
extends MultiContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

The Coordinates Formatter processor creates a normalized chunk for the latitude and longitude.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoordinatesFormatter.LatitudeFormat
static class	CoordinatesFormatter.LongitudeFormat

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

MultiContextDocumentProcessor.InputContexts, MultiContextDocumentProcessor.Transformer<T>

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	latitudeContext
java.lang.String	latitudeFormat
java.lang.String	longitudeContext
java.lang.String	longitudeFormat
java.lang.String	outputContext

Fields inherited from class com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

inputContexts

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
<T> T	accept(MultiContextDocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this CoordinatesFormatter.
static CoordinatesFormatter	fromString(java.lang.String s) String representation of this CoordinatesFormatter.
java.lang.String	getLatitudeContext() The ContextName used as input for the latitude
java.lang.String	getLatitudeFormat() The input format for the latitude Value can be one of DMS Decimal
CoordinatesFormatter.LatitudeFormat	getLatitudeFormatAsEnum() The input format for the latitude Value can be one of DMS Decimal
java.lang.String	getLongitudeContext() The ContextName used as input for the longitude
java.lang.String	getLongitudeFormat() The input format for the longitude Value can be one of DMS Decimal
CoordinatesFormatter.LongitudeFormat	getLongitudeFormatAsEnum() The input format for the longitude Value can be one of DMS Decimal
java.lang.String	getOutputContext() The ContextName used for the newly created chunk.
static boolean	isA(java.lang.String str, CoordinatesFormatter.LatitudeFormat item)
static boolean	isA(java.lang.String str, CoordinatesFormatter.LongitudeFormat item)
static boolean	isOneOf(java.lang.String str, CoordinatesFormatter.LatitudeFormat... items)
static boolean	isOneOf(java.lang.String str, CoordinatesFormatter.LongitudeFormat... items)
CoordinatesFormatter	makeCopy() Creates and returns a deep copy of this CoordinatesFormatter.
static CoordinatesFormatter	readFrom(java.io.InputStream is) Read this CoordinatesFormatter from an XML fragment.
void	setLatitudeContext(java.lang.String latitudeContext) The ContextName used as input for the latitude
void	setLatitudeFormat(CoordinatesFormatter.LatitudeFormat item) The input format for the latitude Value can be one of DMS Decimal
void	setLatitudeFormat(java.lang.String latitudeFormat) The input format for the latitude Value can be one of DMS Decimal
void	setLongitudeContext(java.lang.String longitudeContext) The ContextName used as input for the longitude
void	setLongitudeFormat(CoordinatesFormatter.LongitudeFormat item) The input format for the longitude Value can be one of DMS Decimal
void	setLongitudeFormat(java.lang.String longitudeFormat) The input format for the longitude Value can be one of DMS Decimal
void	setOutputContext(java.lang.String outputContext) The ContextName used for the newly created chunk.
java.lang.String	toString() String representation of this CoordinatesFormatter.
CoordinatesFormatter	withAcceptCondition(AcceptCondition acceptCondition)
CoordinatesFormatter	withDataModelClass(java.lang.String dataModelClass)
CoordinatesFormatter	withDataModelProperty(java.lang.String dataModelProperty)
CoordinatesFormatter	withDataModelState(java.lang.String dataModelState)
CoordinatesFormatter	withDisabled(boolean disabled)
CoordinatesFormatter	withDisabled(java.lang.Boolean disabled)
CoordinatesFormatter	withFromDataModel(DocumentProcessor fromDataModel)
CoordinatesFormatter	withInputContexts(java.util.Collection<StringValue> __values)
CoordinatesFormatter	withInputContexts(StringValue... __values) The processor will only be applied to DocumentChunks with a ContextName specified in this list.
CoordinatesFormatter	withLatitudeContext(java.lang.String latitudeContext)
CoordinatesFormatter	withLatitudeFormat(java.lang.String latitudeFormat)
CoordinatesFormatter	withLongitudeContext(java.lang.String longitudeContext)
CoordinatesFormatter	withLongitudeFormat(java.lang.String longitudeFormat)
CoordinatesFormatter	withName(java.lang.String name)
CoordinatesFormatter	withOutputContext(java.lang.String outputContext)
void	writeTo(java.io.OutputStream os) Write this CoordinatesFormatter as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.MultiContextDocumentProcessor

getInputContexts, setInputContexts, withInputContexts

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

outputContext

public java.lang.String outputContext

latitudeContext

public java.lang.String latitudeContext

latitudeFormat

public java.lang.String latitudeFormat

longitudeContext

public java.lang.String longitudeContext

longitudeFormat

public java.lang.String longitudeFormat

Constructor Detail

CoordinatesFormatter

public CoordinatesFormatter()

CoordinatesFormatter

public CoordinatesFormatter(CoordinatesFormatter o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          CoordinatesFormatter.LatitudeFormat item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              CoordinatesFormatter.LatitudeFormat... items)

setLatitudeFormat

public void setLatitudeFormat(CoordinatesFormatter.LatitudeFormat item)

The input format for the latitude Value can be one of

• DMS
• Decimal

getLatitudeFormatAsEnum

public CoordinatesFormatter.LatitudeFormat getLatitudeFormatAsEnum()

The input format for the latitude Value can be one of

• DMS
• Decimal

isA

public static boolean isA(java.lang.String str,
                          CoordinatesFormatter.LongitudeFormat item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              CoordinatesFormatter.LongitudeFormat... items)

setLongitudeFormat

public void setLongitudeFormat(CoordinatesFormatter.LongitudeFormat item)

The input format for the longitude Value can be one of

• DMS
• Decimal

getLongitudeFormatAsEnum

public CoordinatesFormatter.LongitudeFormat getLongitudeFormatAsEnum()

The input format for the longitude Value can be one of

• DMS
• Decimal

withInputContexts

public CoordinatesFormatter withInputContexts(StringValue... __values)

The processor will only be applied to DocumentChunks with a ContextName specified in this list.

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withInputContexts

public CoordinatesFormatter withInputContexts(java.util.Collection<StringValue> __values)

Overrides:

withInputContexts in class MultiContextDocumentProcessor

withAcceptCondition

public CoordinatesFormatter withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class MultiContextDocumentProcessor

withName

public CoordinatesFormatter withName(java.lang.String name)

Overrides:

withName in class MultiContextDocumentProcessor

withDataModelState

public CoordinatesFormatter withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class MultiContextDocumentProcessor

withFromDataModel

public CoordinatesFormatter withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class MultiContextDocumentProcessor

withDataModelClass

public CoordinatesFormatter withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class MultiContextDocumentProcessor

withDataModelProperty

public CoordinatesFormatter withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class MultiContextDocumentProcessor

withDisabled

public CoordinatesFormatter withDisabled(boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

withDisabled

public CoordinatesFormatter withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class MultiContextDocumentProcessor

setOutputContext

public void setOutputContext(java.lang.String outputContext)

The ContextName used for the newly created chunk.

getOutputContext

public java.lang.String getOutputContext()

The ContextName used for the newly created chunk.

withOutputContext

public CoordinatesFormatter withOutputContext(java.lang.String outputContext)

setLatitudeContext

public void setLatitudeContext(java.lang.String latitudeContext)

The ContextName used as input for the latitude

getLatitudeContext

public java.lang.String getLatitudeContext()

The ContextName used as input for the latitude

withLatitudeContext

public CoordinatesFormatter withLatitudeContext(java.lang.String latitudeContext)

setLatitudeFormat

public void setLatitudeFormat(java.lang.String latitudeFormat)

The input format for the latitude Value can be one of

• DMS
• Decimal

getLatitudeFormat

public java.lang.String getLatitudeFormat()

The input format for the latitude Value can be one of

• DMS
• Decimal

withLatitudeFormat

public CoordinatesFormatter withLatitudeFormat(java.lang.String latitudeFormat)

setLongitudeContext

public void setLongitudeContext(java.lang.String longitudeContext)

The ContextName used as input for the longitude

getLongitudeContext

public java.lang.String getLongitudeContext()

The ContextName used as input for the longitude

withLongitudeContext

public CoordinatesFormatter withLongitudeContext(java.lang.String longitudeContext)

setLongitudeFormat

public void setLongitudeFormat(java.lang.String longitudeFormat)

The input format for the longitude Value can be one of

• DMS
• Decimal

getLongitudeFormat

public java.lang.String getLongitudeFormat()

The input format for the longitude Value can be one of

• DMS
• Decimal

withLongitudeFormat

public CoordinatesFormatter withLongitudeFormat(java.lang.String longitudeFormat)

makeCopy

public CoordinatesFormatter makeCopy()

Creates and returns a deep copy of this CoordinatesFormatter.

Overrides:

makeCopy in class MultiContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class MultiContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CoordinatesFormatter.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CoordinatesFormatter.

Overrides:

toString in class MultiContextDocumentProcessor

check

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

Checks this CoordinatesFormatter.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class MultiContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(MultiContextDocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class MultiContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException