com.exalead.datamodel.v10

Class GeoProperty

java.lang.Object

com.exalead.datamodel.v10.Property

com.exalead.datamodel.v10.DataProperty

com.exalead.datamodel.v10.GeoProperty

All Implemented Interfaces:

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

public class GeoProperty
extends DataProperty
implements com.exalead.util.Checkable, java.io.Serializable

Geo property

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoProperty.Type

Nested classes/interfaces inherited from class com.exalead.datamodel.v10.Property

Property.Arity, Property.Tags

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	type

Fields inherited from class com.exalead.datamodel.v10.DataProperty

additionalMetaNames, advancedParams, dedicatedField, DEFAULT_DEDICATED_FIELD, DEFAULT_DISJUNCTIVE_REFINES, DEFAULT_FACET, DEFAULT_OVERRIDE_CLASS_EXPANSION_PARAMS, DEFAULT_RAM_BASED, DEFAULT_RETRIEVABLE, DEFAULT_SEARCHABLE, defaultValue, disjunctiveRefines, dynamicProperty, facet, overrideClassExpansionParams, ramBased, retrievable, searchable

Fields inherited from class com.exalead.datamodel.v10.Property

arity, ARITY_MANY, ARITY_ONE, ARITY_ZERO_OR_ONE, comment, DEFAULT_ARITY, keyValue, label, name, tags

Constructor Summary

Constructors

Constructor and Description
GeoProperty()
GeoProperty(GeoProperty o) Copy constructor
GeoProperty(java.lang.String name, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this GeoProperty.
static GeoProperty	fromString(java.lang.String s) String representation of this GeoProperty.
java.lang.String	getType() Coordinate system of this geo property. For now, only cartesian/planar systems are supported.
GeoProperty.Type	getTypeAsEnum() Coordinate system of this geo property. For now, only cartesian/planar systems are supported.
static boolean	isA(java.lang.String str, GeoProperty.Type item)
static boolean	isOneOf(java.lang.String str, GeoProperty.Type... items)
GeoProperty	makeCopy() Creates and returns a deep copy of this GeoProperty.
static GeoProperty	readFrom(java.io.InputStream is) Read this GeoProperty from an XML fragment.
void	setType(GeoProperty.Type item) Coordinate system of this geo property. For now, only cartesian/planar systems are supported.
void	setType(java.lang.String type) Coordinate system of this geo property. For now, only cartesian/planar systems are supported.
java.lang.String	toString() String representation of this GeoProperty.
GeoProperty	withAdditionalMetaNames(java.lang.String additionalMetaNames)
GeoProperty	withAdvancedParams(AdvancedParams advancedParams)
GeoProperty	withArity(java.lang.String arity)
GeoProperty	withComment(java.lang.String comment)
GeoProperty	withDedicatedField(boolean dedicatedField)
GeoProperty	withDedicatedField(java.lang.Boolean dedicatedField)
GeoProperty	withDefaultValue(java.lang.String defaultValue)
GeoProperty	withDisjunctiveRefines(boolean disjunctiveRefines)
GeoProperty	withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)
GeoProperty	withDynamicProperty(java.lang.String dynamicProperty)
GeoProperty	withFacet(boolean facet)
GeoProperty	withFacet(java.lang.Boolean facet)
GeoProperty	withKeyValue(java.util.Collection<KeyValue> __values)
GeoProperty	withKeyValue(KeyValue... __values)
GeoProperty	withLabel(java.util.Collection<Label> __values)
GeoProperty	withLabel(Label... __values) Labels for the internationalization of this property's name
GeoProperty	withName(java.lang.String name)
GeoProperty	withOverrideClassExpansionParams(boolean overrideClassExpansionParams)
GeoProperty	withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)
GeoProperty	withRamBased(boolean ramBased)
GeoProperty	withRamBased(java.lang.Boolean ramBased)
GeoProperty	withRetrievable(boolean retrievable)
GeoProperty	withRetrievable(java.lang.Boolean retrievable)
GeoProperty	withSearchable(boolean searchable)
GeoProperty	withSearchable(java.lang.Boolean searchable)
GeoProperty	withTags(java.util.Collection<KeyValue> __values)
GeoProperty	withTags(KeyValue... __values) User-defined tags for this property.
GeoProperty	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this GeoProperty as an XML fragment

Methods inherited from class com.exalead.datamodel.v10.DataProperty

getAdditionalMetaNames, getAdvancedParams, getDefaultValue, getDynamicProperty, isDedicatedField, isDisjunctiveRefines, isFacet, isOverrideClassExpansionParams, isRamBased, isRetrievable, isSearchable, setAdditionalMetaNames, setAdvancedParams, setDedicatedField, setDefaultValue, setDisjunctiveRefines, setDynamicProperty, setFacet, setOverrideClassExpansionParams, setRamBased, setRetrievable, setSearchable

Methods inherited from class com.exalead.datamodel.v10.Property

addKeyValue, getArity, getArityAsEnum, getComment, getKeyValue, getLabel, getName, getTags, isA, isOneOf, setArity, setArity, setComment, setName, setTags, withTags

Methods inherited from class java.lang.Object

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

Field Detail

type

public java.lang.String type

Constructor Detail

GeoProperty

public GeoProperty()

GeoProperty

public GeoProperty(GeoProperty o)

Copy constructor

GeoProperty

public GeoProperty(java.lang.String name,
                   java.lang.String type)

Method Detail

isA

public static boolean isA(java.lang.String str,
                          GeoProperty.Type item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              GeoProperty.Type... items)

setType

public void setType(GeoProperty.Type item)

Coordinate system of this geo property.
For now, only cartesian/planar systems are supported.

getTypeAsEnum

public GeoProperty.Type getTypeAsEnum()

Coordinate system of this geo property.
For now, only cartesian/planar systems are supported.

withAdvancedParams

public GeoProperty withAdvancedParams(AdvancedParams advancedParams)

Overrides:

withAdvancedParams in class DataProperty

withOverrideClassExpansionParams

public GeoProperty withOverrideClassExpansionParams(boolean overrideClassExpansionParams)

Overrides:

withOverrideClassExpansionParams in class DataProperty

withOverrideClassExpansionParams

public GeoProperty withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)

Overrides:

withOverrideClassExpansionParams in class DataProperty

withDedicatedField

public GeoProperty withDedicatedField(boolean dedicatedField)

Overrides:

withDedicatedField in class DataProperty

withDedicatedField

public GeoProperty withDedicatedField(java.lang.Boolean dedicatedField)

Overrides:

withDedicatedField in class DataProperty

withDynamicProperty

public GeoProperty withDynamicProperty(java.lang.String dynamicProperty)

Overrides:

withDynamicProperty in class DataProperty

withSearchable

public GeoProperty withSearchable(boolean searchable)

Overrides:

withSearchable in class DataProperty

withSearchable

public GeoProperty withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class DataProperty

withRetrievable

public GeoProperty withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class DataProperty

withRetrievable

public GeoProperty withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class DataProperty

withRamBased

public GeoProperty withRamBased(boolean ramBased)

Overrides:

withRamBased in class DataProperty

withRamBased

public GeoProperty withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class DataProperty

withFacet

public GeoProperty withFacet(boolean facet)

Overrides:

withFacet in class DataProperty

withFacet

public GeoProperty withFacet(java.lang.Boolean facet)

Overrides:

withFacet in class DataProperty

withDisjunctiveRefines

public GeoProperty withDisjunctiveRefines(boolean disjunctiveRefines)

Overrides:

withDisjunctiveRefines in class DataProperty

withDisjunctiveRefines

public GeoProperty withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)

Overrides:

withDisjunctiveRefines in class DataProperty

withDefaultValue

public GeoProperty withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class DataProperty

withAdditionalMetaNames

public GeoProperty withAdditionalMetaNames(java.lang.String additionalMetaNames)

Overrides:

withAdditionalMetaNames in class DataProperty

withKeyValue

public GeoProperty withKeyValue(KeyValue... __values)

Overrides:

withKeyValue in class DataProperty

withKeyValue

public GeoProperty withKeyValue(java.util.Collection<KeyValue> __values)

Overrides:

withKeyValue in class DataProperty

withArity

public GeoProperty withArity(java.lang.String arity)

Overrides:

withArity in class DataProperty

withName

public GeoProperty withName(java.lang.String name)

Overrides:

withName in class DataProperty

withComment

public GeoProperty withComment(java.lang.String comment)

Overrides:

withComment in class DataProperty

withLabel

public GeoProperty withLabel(Label... __values)

Labels for the internationalization of this property's name

Overrides:

withLabel in class DataProperty

withLabel

public GeoProperty withLabel(java.util.Collection<Label> __values)

Overrides:

withLabel in class DataProperty

withTags

public GeoProperty withTags(KeyValue... __values)

User-defined tags for this property. This can be used for example to implement 6W faceting of the data model.

Overrides:

withTags in class DataProperty

withTags

public GeoProperty withTags(java.util.Collection<KeyValue> __values)

Overrides:

withTags in class DataProperty

setType

public void setType(java.lang.String type)

Coordinate system of this geo property.
For now, only cartesian/planar systems are supported.

getType

public java.lang.String getType()

Coordinate system of this geo property.
For now, only cartesian/planar systems are supported.

withType

public GeoProperty withType(java.lang.String type)

makeCopy

public GeoProperty makeCopy()

Creates and returns a deep copy of this GeoProperty.

Overrides:

makeCopy in class DataProperty

readFrom

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

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

Overrides:

writeTo in class DataProperty

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this GeoProperty.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this GeoProperty.

Overrides:

toString in class DataProperty

check

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

Checks this GeoProperty.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DataProperty

Throws:

com.exalead.util.TypedException