com.exalead.datamodel.v10

Class NumericalProperty

java.lang.Object

com.exalead.datamodel.v10.Property

com.exalead.datamodel.v10.DataProperty

com.exalead.datamodel.v10.NumericalProperty

All Implemented Interfaces:

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

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

Numerical properties offer the feature of optionally enabling range (superior, inferior, ...) on values

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumericalProperty.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
NumericalProperty()
NumericalProperty(NumericalProperty o) Copy constructor
NumericalProperty(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 NumericalProperty.
static NumericalProperty	fromString(java.lang.String s) String representation of this NumericalProperty.
java.lang.String	getType() Type of this numerical property.
NumericalProperty.Type	getTypeAsEnum() Type of this numerical property.
static boolean	isA(java.lang.String str, NumericalProperty.Type item)
static boolean	isOneOf(java.lang.String str, NumericalProperty.Type... items)
NumericalProperty	makeCopy() Creates and returns a deep copy of this NumericalProperty.
static NumericalProperty	readFrom(java.io.InputStream is) Read this NumericalProperty from an XML fragment.
void	setType(NumericalProperty.Type item) Type of this numerical property.
void	setType(java.lang.String type) Type of this numerical property.
java.lang.String	toString() String representation of this NumericalProperty.
NumericalProperty	withAdditionalMetaNames(java.lang.String additionalMetaNames)
NumericalProperty	withAdvancedParams(AdvancedParams advancedParams)
NumericalProperty	withArity(java.lang.String arity)
NumericalProperty	withComment(java.lang.String comment)
NumericalProperty	withDedicatedField(boolean dedicatedField)
NumericalProperty	withDedicatedField(java.lang.Boolean dedicatedField)
NumericalProperty	withDefaultValue(java.lang.String defaultValue)
NumericalProperty	withDisjunctiveRefines(boolean disjunctiveRefines)
NumericalProperty	withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)
NumericalProperty	withDynamicProperty(java.lang.String dynamicProperty)
NumericalProperty	withFacet(boolean facet)
NumericalProperty	withFacet(java.lang.Boolean facet)
NumericalProperty	withKeyValue(java.util.Collection<KeyValue> __values)
NumericalProperty	withKeyValue(KeyValue... __values)
NumericalProperty	withLabel(java.util.Collection<Label> __values)
NumericalProperty	withLabel(Label... __values) Labels for the internationalization of this property's name
NumericalProperty	withName(java.lang.String name)
NumericalProperty	withOverrideClassExpansionParams(boolean overrideClassExpansionParams)
NumericalProperty	withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)
NumericalProperty	withRamBased(boolean ramBased)
NumericalProperty	withRamBased(java.lang.Boolean ramBased)
NumericalProperty	withRetrievable(boolean retrievable)
NumericalProperty	withRetrievable(java.lang.Boolean retrievable)
NumericalProperty	withSearchable(boolean searchable)
NumericalProperty	withSearchable(java.lang.Boolean searchable)
NumericalProperty	withTags(java.util.Collection<KeyValue> __values)
NumericalProperty	withTags(KeyValue... __values) User-defined tags for this property.
NumericalProperty	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this NumericalProperty 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

NumericalProperty

public NumericalProperty()

NumericalProperty

public NumericalProperty(NumericalProperty o)

Copy constructor

NumericalProperty

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

Method Detail

isA

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

isOneOf

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

setType

public void setType(NumericalProperty.Type item)

Type of this numerical property. Depending on the type, additional validation and formating will be performed on the value. Valid values are:

• integer: The value must be an integer (this is the default).
• double: The value must be a double. It is possible to configure the precision in advanced parameters.
• date: A date, with a day precision.
• date_time: A date, with time (second precision).
• point_geo: A point on a sphere, in GPS coordinates. The value must have a "latitude,longitude" format, with latitude being a double between -90 and +90, and longitude being a double between -180 and 180.
• point_xy: A point on a XY plan. The value must have a "X,Y" format, with X and Y being positive integers.
• unsigned: The value must be a positive integer.
• measure: The value must be a double and could be associated to a unit of measurement symbol.

getTypeAsEnum

public NumericalProperty.Type getTypeAsEnum()

Type of this numerical property. Depending on the type, additional validation and formating will be performed on the value. Valid values are:

• integer: The value must be an integer (this is the default).
• double: The value must be a double. It is possible to configure the precision in advanced parameters.
• date: A date, with a day precision.
• date_time: A date, with time (second precision).
• point_geo: A point on a sphere, in GPS coordinates. The value must have a "latitude,longitude" format, with latitude being a double between -90 and +90, and longitude being a double between -180 and 180.
• point_xy: A point on a XY plan. The value must have a "X,Y" format, with X and Y being positive integers.
• unsigned: The value must be a positive integer.
• measure: The value must be a double and could be associated to a unit of measurement symbol.

withAdvancedParams

public NumericalProperty withAdvancedParams(AdvancedParams advancedParams)

Overrides:

withAdvancedParams in class DataProperty

withOverrideClassExpansionParams

public NumericalProperty withOverrideClassExpansionParams(boolean overrideClassExpansionParams)

Overrides:

withOverrideClassExpansionParams in class DataProperty

withOverrideClassExpansionParams

public NumericalProperty withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)

Overrides:

withOverrideClassExpansionParams in class DataProperty

withDedicatedField

public NumericalProperty withDedicatedField(boolean dedicatedField)

Overrides:

withDedicatedField in class DataProperty

withDedicatedField

public NumericalProperty withDedicatedField(java.lang.Boolean dedicatedField)

Overrides:

withDedicatedField in class DataProperty

withDynamicProperty

public NumericalProperty withDynamicProperty(java.lang.String dynamicProperty)

Overrides:

withDynamicProperty in class DataProperty

withSearchable

public NumericalProperty withSearchable(boolean searchable)

Overrides:

withSearchable in class DataProperty

withSearchable

public NumericalProperty withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class DataProperty

withRetrievable

public NumericalProperty withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class DataProperty

withRetrievable

public NumericalProperty withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class DataProperty

withRamBased

public NumericalProperty withRamBased(boolean ramBased)

Overrides:

withRamBased in class DataProperty

withRamBased

public NumericalProperty withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class DataProperty

withFacet

public NumericalProperty withFacet(boolean facet)

Overrides:

withFacet in class DataProperty

withFacet

public NumericalProperty withFacet(java.lang.Boolean facet)

Overrides:

withFacet in class DataProperty

withDisjunctiveRefines

public NumericalProperty withDisjunctiveRefines(boolean disjunctiveRefines)

Overrides:

withDisjunctiveRefines in class DataProperty

withDisjunctiveRefines

public NumericalProperty withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)

Overrides:

withDisjunctiveRefines in class DataProperty

withDefaultValue

public NumericalProperty withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class DataProperty

withAdditionalMetaNames

public NumericalProperty withAdditionalMetaNames(java.lang.String additionalMetaNames)

Overrides:

withAdditionalMetaNames in class DataProperty

withKeyValue

public NumericalProperty withKeyValue(KeyValue... __values)

Overrides:

withKeyValue in class DataProperty

withKeyValue

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

Overrides:

withKeyValue in class DataProperty

withArity

public NumericalProperty withArity(java.lang.String arity)

Overrides:

withArity in class DataProperty

withName

public NumericalProperty withName(java.lang.String name)

Overrides:

withName in class DataProperty

withComment

public NumericalProperty withComment(java.lang.String comment)

Overrides:

withComment in class DataProperty

withLabel

public NumericalProperty withLabel(Label... __values)

Labels for the internationalization of this property's name

Overrides:

withLabel in class DataProperty

withLabel

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

Overrides:

withLabel in class DataProperty

withTags

public NumericalProperty 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 NumericalProperty withTags(java.util.Collection<KeyValue> __values)

Overrides:

withTags in class DataProperty

setType

public void setType(java.lang.String type)

Type of this numerical property. Depending on the type, additional validation and formating will be performed on the value. Valid values are:

• integer: The value must be an integer (this is the default).
• double: The value must be a double. It is possible to configure the precision in advanced parameters.
• date: A date, with a day precision.
• date_time: A date, with time (second precision).
• point_geo: A point on a sphere, in GPS coordinates. The value must have a "latitude,longitude" format, with latitude being a double between -90 and +90, and longitude being a double between -180 and 180.
• point_xy: A point on a XY plan. The value must have a "X,Y" format, with X and Y being positive integers.
• unsigned: The value must be a positive integer.
• measure: The value must be a double and could be associated to a unit of measurement symbol.

getType

public java.lang.String getType()

Type of this numerical property. Depending on the type, additional validation and formating will be performed on the value. Valid values are:

• integer: The value must be an integer (this is the default).
• double: The value must be a double. It is possible to configure the precision in advanced parameters.
• date: A date, with a day precision.
• date_time: A date, with time (second precision).
• point_geo: A point on a sphere, in GPS coordinates. The value must have a "latitude,longitude" format, with latitude being a double between -90 and +90, and longitude being a double between -180 and 180.
• point_xy: A point on a XY plan. The value must have a "X,Y" format, with X and Y being positive integers.
• unsigned: The value must be a positive integer.
• measure: The value must be a double and could be associated to a unit of measurement symbol.

withType

public NumericalProperty withType(java.lang.String type)

makeCopy

public NumericalProperty makeCopy()

Creates and returns a deep copy of this NumericalProperty.

Overrides:

makeCopy in class DataProperty

readFrom

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

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

Overrides:

writeTo in class DataProperty

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NumericalProperty.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NumericalProperty.

Overrides:

toString in class DataProperty

check

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

Checks this NumericalProperty.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DataProperty

Throws:

com.exalead.util.TypedException