DataProperty (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.datamodel.v10.Property
- - com.exalead.datamodel.v10.DataProperty

All Implemented Interfaces:

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

Direct Known Subclasses:

AlphanumProperty, GeoProperty, NumericalProperty
```
public abstract class DataProperty
extends Property
implements com.exalead.util.Checkable, java.io.Serializable
```
A property representing a single object attribute.

See Also:

Serialized Form

Nested Class Summary
- 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`	`additionalMetaNames`
`AdvancedParams`	`advancedParams`
`boolean`	`dedicatedField`
`static boolean`	`DEFAULT_DEDICATED_FIELD`
`static boolean`	`DEFAULT_DISJUNCTIVE_REFINES`
`static boolean`	`DEFAULT_FACET`
`static boolean`	`DEFAULT_OVERRIDE_CLASS_EXPANSION_PARAMS`
`static boolean`	`DEFAULT_RAM_BASED`
`static boolean`	`DEFAULT_RETRIEVABLE`
`static boolean`	`DEFAULT_SEARCHABLE`
`java.lang.String`	`defaultValue`
`boolean`	`disjunctiveRefines`
`java.lang.String`	`dynamicProperty`
`boolean`	`facet`
`boolean`	`overrideClassExpansionParams`
`boolean`	`ramBased`
`boolean`	`retrievable`
`boolean`	`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

DataProperty()

DataProperty(DataProperty o)
Copy constructor

DataProperty(java.lang.String name)

Constructors
Constructor and Description
`DataProperty()`
`DataProperty(DataProperty o)` Copy constructor
`DataProperty(java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this DataProperty.
`static DataProperty`	`fromString(java.lang.String s)` String representation of this DataProperty.
`java.lang.String`	`getAdditionalMetaNames()` Maps these metas (as a comma-separated list) to this index or facet field. Usable only for properties having a dedicated field, a facet, or are searchable without prefix.
`AdvancedParams`	`getAdvancedParams()`
`java.lang.String`	`getDefaultValue()` If there is no value for this property in the document, use this default value.
`java.lang.String`	`getDynamicProperty()` Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time.
`boolean`	`isDedicatedField()` Should we create a dedicated index field for this property, or use a multi-field encoding? A dedicated field is recommended if more than a few percent of objects have this property. Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words.
`boolean`	`isDisjunctiveRefines()` Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one).
`boolean`	`isFacet()` Creates a navigation facet from the property values.
`boolean`	`isOverrideClassExpansionParams()`
`boolean`	`isRamBased()` Stores this property in RAM.
`boolean`	`isRetrievable()` Displays the meta in the hit content of search results. If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field.
`boolean`	`isSearchable()` Allows users to search for matches in this property using a prefix. For example, to search for "API" in the title of a document, enter the search query
`DataProperty`	`makeCopy()`
`static DataProperty`	`readFrom(java.io.InputStream is)` Read this DataProperty from an XML fragment.
`void`	`setAdditionalMetaNames(java.lang.String additionalMetaNames)` Maps these metas (as a comma-separated list) to this index or facet field. Usable only for properties having a dedicated field, a facet, or are searchable without prefix.
`void`	`setAdvancedParams(AdvancedParams advancedParams)`
`void`	`setDedicatedField(boolean dedicatedField)` Should we create a dedicated index field for this property, or use a multi-field encoding? A dedicated field is recommended if more than a few percent of objects have this property. Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words.
`void`	`setDefaultValue(java.lang.String defaultValue)` If there is no value for this property in the document, use this default value.
`void`	`setDisjunctiveRefines(boolean disjunctiveRefines)` Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one).
`void`	`setDynamicProperty(java.lang.String dynamicProperty)` Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time.
`void`	`setFacet(boolean facet)` Creates a navigation facet from the property values.
`void`	`setOverrideClassExpansionParams(boolean overrideClassExpansionParams)`
`void`	`setRamBased(boolean ramBased)` Stores this property in RAM.
`void`	`setRetrievable(boolean retrievable)` Displays the meta in the hit content of search results. If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field.
`void`	`setSearchable(boolean searchable)` Allows users to search for matches in this property using a prefix. For example, to search for "API" in the title of a document, enter the search query
`java.lang.String`	`toString()` String representation of this DataProperty.
`DataProperty`	`withAdditionalMetaNames(java.lang.String additionalMetaNames)`
`DataProperty`	`withAdvancedParams(AdvancedParams advancedParams)`
`DataProperty`	`withArity(java.lang.String arity)`
`DataProperty`	`withComment(java.lang.String comment)`
`DataProperty`	`withDedicatedField(boolean dedicatedField)`
`DataProperty`	`withDedicatedField(java.lang.Boolean dedicatedField)`
`DataProperty`	`withDefaultValue(java.lang.String defaultValue)`
`DataProperty`	`withDisjunctiveRefines(boolean disjunctiveRefines)`
`DataProperty`	`withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)`
`DataProperty`	`withDynamicProperty(java.lang.String dynamicProperty)`
`DataProperty`	`withFacet(boolean facet)`
`DataProperty`	`withFacet(java.lang.Boolean facet)`
`DataProperty`	`withKeyValue(java.util.Collection<KeyValue> __values)`
`DataProperty`	`withKeyValue(KeyValue... __values)`
`DataProperty`	`withLabel(java.util.Collection<Label> __values)`
`DataProperty`	`withLabel(Label... __values)` Labels for the internationalization of this property's name
`DataProperty`	`withName(java.lang.String name)`
`DataProperty`	`withOverrideClassExpansionParams(boolean overrideClassExpansionParams)`
`DataProperty`	`withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)`
`DataProperty`	`withRamBased(boolean ramBased)`
`DataProperty`	`withRamBased(java.lang.Boolean ramBased)`
`DataProperty`	`withRetrievable(boolean retrievable)`
`DataProperty`	`withRetrievable(java.lang.Boolean retrievable)`
`DataProperty`	`withSearchable(boolean searchable)`
`DataProperty`	`withSearchable(java.lang.Boolean searchable)`
`DataProperty`	`withTags(java.util.Collection<KeyValue> __values)`
`DataProperty`	`withTags(KeyValue... __values)` User-defined tags for this property.
`void`	`writeTo(java.io.OutputStream os)`

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
  - advancedParams
```
public AdvancedParams advancedParams
```
  - overrideClassExpansionParams
```
public boolean overrideClassExpansionParams
```
  - DEFAULT_OVERRIDE_CLASS_EXPANSION_PARAMS
```
public static final boolean DEFAULT_OVERRIDE_CLASS_EXPANSION_PARAMS
```
    See Also:
    
    Constant Field Values
  - dedicatedField
```
public boolean dedicatedField
```
  - DEFAULT_DEDICATED_FIELD
```
public static final boolean DEFAULT_DEDICATED_FIELD
```
    See Also:
    
    Constant Field Values
  - dynamicProperty
```
public java.lang.String dynamicProperty
```
  - searchable
```
public boolean searchable
```
  - DEFAULT_SEARCHABLE
```
public static final boolean DEFAULT_SEARCHABLE
```
    See Also:
    
    Constant Field Values
  - retrievable
```
public boolean retrievable
```
  - DEFAULT_RETRIEVABLE
```
public static final boolean DEFAULT_RETRIEVABLE
```
    See Also:
    
    Constant Field Values
  - ramBased
```
public boolean ramBased
```
  - DEFAULT_RAM_BASED
```
public static final boolean DEFAULT_RAM_BASED
```
    See Also:
    
    Constant Field Values
  - facet
```
public boolean facet
```
  - DEFAULT_FACET
```
public static final boolean DEFAULT_FACET
```
    See Also:
    
    Constant Field Values
  - disjunctiveRefines
```
public boolean disjunctiveRefines
```
  - DEFAULT_DISJUNCTIVE_REFINES
```
public static final boolean DEFAULT_DISJUNCTIVE_REFINES
```
    See Also:
    
    Constant Field Values
  - defaultValue
```
public java.lang.String defaultValue
```
  - additionalMetaNames
```
public java.lang.String additionalMetaNames
```
- Constructor Detail
  - DataProperty
```
public DataProperty()
```
  - DataProperty
```
public DataProperty(DataProperty o)
```
    Copy constructor
  - DataProperty
```
public DataProperty(java.lang.String name)
```
- Method Detail
  - withKeyValue
```
public DataProperty withKeyValue(KeyValue... __values)
```
    Overrides:
    
    withKeyValue in class Property
  - withKeyValue
```
public DataProperty withKeyValue(java.util.Collection<KeyValue> __values)
```
    Overrides:
    
    withKeyValue in class Property
  - withArity
```
public DataProperty withArity(java.lang.String arity)
```
    Overrides:
    
    withArity in class Property
  - withName
```
public DataProperty withName(java.lang.String name)
```
    Overrides:
    
    withName in class Property
  - withComment
```
public DataProperty withComment(java.lang.String comment)
```
    Overrides:
    
    withComment in class Property
  - withLabel
```
public DataProperty withLabel(Label... __values)
```
    Labels for the internationalization of this property's name
    
    Overrides:
    
    withLabel in class Property
  - withLabel
```
public DataProperty withLabel(java.util.Collection<Label> __values)
```
    Overrides:
    
    withLabel in class Property
  - withTags
```
public DataProperty 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 Property
  - withTags
```
public DataProperty withTags(java.util.Collection<KeyValue> __values)
```
    Overrides:
    
    withTags in class Property
  - setAdvancedParams
```
public void setAdvancedParams(AdvancedParams advancedParams)
```
  - getAdvancedParams
```
public AdvancedParams getAdvancedParams()
```
  - withAdvancedParams
```
public DataProperty withAdvancedParams(AdvancedParams advancedParams)
```
  - setOverrideClassExpansionParams
```
public void setOverrideClassExpansionParams(boolean overrideClassExpansionParams)
```
  - isOverrideClassExpansionParams
```
public boolean isOverrideClassExpansionParams()
```
  - withOverrideClassExpansionParams
```
public DataProperty withOverrideClassExpansionParams(boolean overrideClassExpansionParams)
```
  - withOverrideClassExpansionParams
```
public DataProperty withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)
```
  - setDedicatedField
```
public void setDedicatedField(boolean dedicatedField)
```
    Should we create a dedicated index field for this property, or use a multi-field encoding?
    A dedicated field is recommended if more than a few percent of objects have this property.
    Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words.
  - isDedicatedField
```
public boolean isDedicatedField()
```
    Should we create a dedicated index field for this property, or use a multi-field encoding?
    A dedicated field is recommended if more than a few percent of objects have this property.
    Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words.
  - withDedicatedField
```
public DataProperty withDedicatedField(boolean dedicatedField)
```
  - withDedicatedField
```
public DataProperty withDedicatedField(java.lang.Boolean dedicatedField)
```
  - setDynamicProperty
```
public void setDynamicProperty(java.lang.String dynamicProperty)
```
    Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time. Faceting and sorting performances will be impacted (slower).
  - getDynamicProperty
```
public java.lang.String getDynamicProperty()
```
    Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time. Faceting and sorting performances will be impacted (slower).
  - withDynamicProperty
```
public DataProperty withDynamicProperty(java.lang.String dynamicProperty)
```
  - setSearchable
```
public void setSearchable(boolean searchable)
```
    Allows users to search for matches in this property using a prefix.
    
    For example, to search for "API" in the title of a document, enter the search query
```
title:API
```
  - isSearchable
```
public boolean isSearchable()
```
    Allows users to search for matches in this property using a prefix.
    
    For example, to search for "API" in the title of a document, enter the search query
```
title:API
```
  - withSearchable
```
public DataProperty withSearchable(boolean searchable)
```
  - withSearchable
```
public DataProperty withSearchable(java.lang.Boolean searchable)
```
  - setRetrievable
```
public void setRetrievable(boolean retrievable)
```
    Displays the meta in the hit content of search results.
    
    If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field.
  - isRetrievable
```
public boolean isRetrievable()
```
    Displays the meta in the hit content of search results.
    
    If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field.
  - withRetrievable
```
public DataProperty withRetrievable(boolean retrievable)
```
  - withRetrievable
```
public DataProperty withRetrievable(java.lang.Boolean retrievable)
```
  - setRamBased
```
public void setRamBased(boolean ramBased)
```
    Stores this property in RAM. Use this option if you need to:
    - sort search results on this property.
    - use this property in a virtual field.
    - use this property in a virtual facet.
    - use this property for an aggregation value.
    Only the "retrievable" part of the property is stored in RAM.
  - isRamBased
```
public boolean isRamBased()
```
    Stores this property in RAM. Use this option if you need to:
    - sort search results on this property.
    - use this property in a virtual field.
    - use this property in a virtual facet.
    - use this property for an aggregation value.
    Only the "retrievable" part of the property is stored in RAM.
  - withRamBased
```
public DataProperty withRamBased(boolean ramBased)
```
  - withRamBased
```
public DataProperty withRamBased(java.lang.Boolean ramBased)
```
  - setFacet
```
public void setFacet(boolean facet)
```
    Creates a navigation facet from the property values.
  - isFacet
```
public boolean isFacet()
```
    Creates a navigation facet from the property values.
  - withFacet
```
public DataProperty withFacet(boolean facet)
```
  - withFacet
```
public DataProperty withFacet(java.lang.Boolean facet)
```
  - setDisjunctiveRefines
```
public void setDisjunctiveRefines(boolean disjunctiveRefines)
```
    Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one).
  - isDisjunctiveRefines
```
public boolean isDisjunctiveRefines()
```
    Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one).
  - withDisjunctiveRefines
```
public DataProperty withDisjunctiveRefines(boolean disjunctiveRefines)
```
  - withDisjunctiveRefines
```
public DataProperty withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)
```
  - setDefaultValue
```
public void setDefaultValue(java.lang.String defaultValue)
```
    If there is no value for this property in the document, use this default value.
  - getDefaultValue
```
public java.lang.String getDefaultValue()
```
    If there is no value for this property in the document, use this default value.
  - withDefaultValue
```
public DataProperty withDefaultValue(java.lang.String defaultValue)
```
  - setAdditionalMetaNames
```
public void setAdditionalMetaNames(java.lang.String additionalMetaNames)
```
    Maps these metas (as a comma-separated list) to this index or facet field.
    Usable only for properties having a dedicated field, a facet, or are searchable without prefix.
  - getAdditionalMetaNames
```
public java.lang.String getAdditionalMetaNames()
```
    Maps these metas (as a comma-separated list) to this index or facet field.
    Usable only for properties having a dedicated field, a facet, or are searchable without prefix.
  - withAdditionalMetaNames
```
public DataProperty withAdditionalMetaNames(java.lang.String additionalMetaNames)
```
  - makeCopy
```
public DataProperty makeCopy()
```
    Overrides:
    
    makeCopy in class Property
  - readFrom
```
public static DataProperty readFrom(java.io.InputStream is)
                             throws javax.xml.bind.JAXBException
```
    Read this DataProperty 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
```
    Overrides:
    
    writeTo in class Property
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static DataProperty fromString(java.lang.String s)
                               throws javax.xml.bind.JAXBException,
                                      java.io.UnsupportedEncodingException
```
    String representation of this DataProperty.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this DataProperty.
    
    Overrides:
    
    toString in class Property
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this DataProperty.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class Property
    
    Throws:
    
    com.exalead.util.TypedException

Class DataProperty

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

advancedParams

overrideClassExpansionParams

DEFAULT_OVERRIDE_CLASS_EXPANSION_PARAMS

dedicatedField

DEFAULT_DEDICATED_FIELD

dynamicProperty

searchable

DEFAULT_SEARCHABLE

retrievable

DEFAULT_RETRIEVABLE

ramBased

DEFAULT_RAM_BASED

facet

DEFAULT_FACET

disjunctiveRefines

DEFAULT_DISJUNCTIVE_REFINES

defaultValue

additionalMetaNames

Constructor Detail

DataProperty

DataProperty

DataProperty

Method Detail

withKeyValue

withKeyValue

withArity

withName

withComment

withLabel

withLabel

withTags

withTags

setAdvancedParams

getAdvancedParams

withAdvancedParams

setOverrideClassExpansionParams

isOverrideClassExpansionParams

withOverrideClassExpansionParams

withOverrideClassExpansionParams

setDedicatedField

isDedicatedField

withDedicatedField

withDedicatedField

setDynamicProperty

getDynamicProperty

withDynamicProperty

setSearchable

isSearchable

withSearchable

withSearchable

setRetrievable

isRetrievable

withRetrievable

withRetrievable

setRamBased

isRamBased

withRamBased

withRamBased

setFacet

isFacet

withFacet

withFacet

setDisjunctiveRefines

isDisjunctiveRefines

withDisjunctiveRefines

withDisjunctiveRefines

setDefaultValue

getDefaultValue

withDefaultValue

setAdditionalMetaNames