com.exalead.datamodel.v10

Class DynamicProperty

java.lang.Object

com.exalead.datamodel.v10.DynamicProperty

All Implemented Interfaces:

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

public class DynamicProperty
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Allows you to define matching rules to map multiple document meta names to a single property, and consequently to a single index field or category facet (or output context, if neither index field nor category facet is selected).
This is useful when you do not know all the metas available in your data source. It also reduces the number of fields needed in the index.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_STORE_META_NAMES
java.util.List<MatchingRule>	matchingRule
Property	property
boolean	storeMetaNames

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DynamicProperty.
static DynamicProperty	fromString(java.lang.String s) String representation of this DynamicProperty.
java.util.List<MatchingRule>	getMatchingRule() List of rules to define which document metas should be mapped to this dynamic property.
Property	getProperty() All property attributes apply to this dynamic property.
boolean	isStoreMetaNames() Stores the meta name associated to each value, in the resulting index field (or category facet or output context).
DynamicProperty	makeCopy() Creates and returns a deep copy of this DynamicProperty.
static DynamicProperty	readFrom(java.io.InputStream is) Read this DynamicProperty from an XML fragment.
void	setProperty(Property property) All property attributes apply to this dynamic property.
void	setStoreMetaNames(boolean storeMetaNames) Stores the meta name associated to each value, in the resulting index field (or category facet or output context).
java.lang.String	toString() String representation of this DynamicProperty.
DynamicProperty	withMatchingRule(java.util.Collection<MatchingRule> __values)
DynamicProperty	withMatchingRule(MatchingRule... __values) List of rules to define which document metas should be mapped to this dynamic property.
DynamicProperty	withProperty(Property property)
DynamicProperty	withStoreMetaNames(boolean storeMetaNames)
DynamicProperty	withStoreMetaNames(java.lang.Boolean storeMetaNames)
void	writeTo(java.io.OutputStream os) Write this DynamicProperty as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

property

public Property property

storeMetaNames

public boolean storeMetaNames

DEFAULT_STORE_META_NAMES

public static final boolean DEFAULT_STORE_META_NAMES

See Also:

Constant Field Values

matchingRule

public java.util.List<MatchingRule> matchingRule

Constructor Detail

DynamicProperty

public DynamicProperty()

DynamicProperty

public DynamicProperty(DynamicProperty o)

Copy constructor

Method Detail

setProperty

public void setProperty(Property property)

All property attributes apply to this dynamic property.

getProperty

public Property getProperty()

All property attributes apply to this dynamic property.

withProperty

public DynamicProperty withProperty(Property property)

setStoreMetaNames

public void setStoreMetaNames(boolean storeMetaNames)

Stores the meta name associated to each value, in the resulting index field (or category facet or output context). This is useful to search and retrieve specific metas within the field.
If 'Store meta names' is not selected for a dynamic property, the resulting index field (or category facet or output context) is the same as any other alphanumerical or numerical field created with standard properties: it contains only meta values.

isStoreMetaNames

public boolean isStoreMetaNames()

Stores the meta name associated to each value, in the resulting index field (or category facet or output context). This is useful to search and retrieve specific metas within the field.
If 'Store meta names' is not selected for a dynamic property, the resulting index field (or category facet or output context) is the same as any other alphanumerical or numerical field created with standard properties: it contains only meta values.

withStoreMetaNames

public DynamicProperty withStoreMetaNames(boolean storeMetaNames)

withStoreMetaNames

public DynamicProperty withStoreMetaNames(java.lang.Boolean storeMetaNames)

getMatchingRule

public java.util.List<MatchingRule> getMatchingRule()

List of rules to define which document metas should be mapped to this dynamic property.

withMatchingRule

public DynamicProperty withMatchingRule(MatchingRule... __values)

List of rules to define which document metas should be mapped to this dynamic property.

withMatchingRule

public DynamicProperty withMatchingRule(java.util.Collection<MatchingRule> __values)

makeCopy

public DynamicProperty makeCopy()

Creates and returns a deep copy of this DynamicProperty.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DynamicProperty.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DynamicProperty.

Overrides:

toString in class java.lang.Object

check

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

Checks this DynamicProperty.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException