com.exalead.datamodel.v10

Class DataModel

java.lang.Object

com.exalead.datamodel.v10.DataModel

All Implemented Interfaces:

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

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

CloudView Data Model

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<DataModelClass>	dataModelClass
java.util.List<DataModelEnum>	dataModelEnum
static boolean	DEFAULT_EXPAND_NAMED_ENTITIES_LIKE_IN2014
static boolean	DEFAULT_STORE_ALL_METAS
static boolean	DEFAULT_TRACE_ALL_METAS
java.lang.String	defaultClass
boolean	expandNamedEntitiesLikeIn2014
java.lang.String	name
java.lang.String	possibleLanguages
java.util.List<SemanticType>	semanticType
boolean	storeAllMetas
boolean	traceAllMetas

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addClass(DataModelClass classDef)
void	addSignedProperty(java.lang.String className, java.lang.String name) Add a signed property to a class.
void	check(boolean deep, java.lang.String errorContext) Checks this DataModel.
static DataModel	fromString(java.lang.String s) String representation of this DataModel.
DataModelClass	getClass(java.lang.String name) Get an existing class, returns null if it does not exist
java.util.List<DataModelClass>	getDataModelClass() List of classes of this data model.
java.util.Map<java.lang.String,DataModelClass>	getDataModelClassAsMap() Get the map of DataModelClass, indexed by name
DataModelClass	getDataModelClassByName(java.lang.String _lookup) Get the DataModelClass for which the name matches _lookup
java.util.List<DataModelEnum>	getDataModelEnum()
java.util.Map<java.lang.String,DataModelEnum>	getDataModelEnumAsMap() Get the map of DataModelEnum, indexed by name
DataModelEnum	getDataModelEnumByName(java.lang.String _lookup) Get the DataModelEnum for which the name matches _lookup
java.lang.String	getDefaultClass() Default class to push documents when there is no "datamodel_class" papi directive, or no "TYPE" meta.
java.lang.String	getName() Name of this Data Model.
DataModelClass	getOrCreateClass(java.lang.String name) Get a class, create it if it does not already exist
java.lang.String	getPossibleLanguages() The list of languages that can appear in the corpus. Language detection will be restricted to this set. A null value means that all languages are possible.
java.util.List<SemanticType>	getSemanticType() The list of semantic types of this data model. A semantic type defines the semantic analysis to perform, and can be assigned to 'alphanumeric' properties. The semantic types available out of the box are: text, identifier, meta, and url.
java.util.Map<java.lang.String,SemanticType>	getSemanticTypeAsMap() Get the map of SemanticType, indexed by name
SemanticType	getSemanticTypeByName(java.lang.String _lookup) Get the SemanticType for which the name matches _lookup
boolean	isExpandNamedEntitiesLikeIn2014()
boolean	isStoreAllMetas() Saves all metas that were not mapped to an index field or category as "csv encoded metas". These metas are retrievable only.
boolean	isTraceAllMetas() Select this option before indexing, then click "Add Properties from Traced Metas" to simplify creating new properties. The traced metas are stored in a separate database.
DataModel	makeCopy() Creates and returns a deep copy of this DataModel.
static DataModel	readFrom(java.io.InputStream is) Read this DataModel from an XML fragment.
boolean	removeDataModelClassByName(java.lang.String _lookup) Removes the DataModelClass for which the name matches _lookup
boolean	removeDataModelEnumByName(java.lang.String _lookup) Removes the DataModelEnum for which the name matches _lookup
boolean	removeSemanticTypeByName(java.lang.String _lookup) Removes the SemanticType for which the name matches _lookup
void	setDefaultClass(java.lang.String defaultClass) Default class to push documents when there is no "datamodel_class" papi directive, or no "TYPE" meta.
void	setExpandNamedEntitiesLikeIn2014(boolean expandNamedEntitiesLikeIn2014)
void	setName(java.lang.String name) Name of this Data Model.
void	setPossibleLanguages(java.lang.String possibleLanguages) The list of languages that can appear in the corpus. Language detection will be restricted to this set. A null value means that all languages are possible.
void	setStoreAllMetas(boolean storeAllMetas) Saves all metas that were not mapped to an index field or category as "csv encoded metas". These metas are retrievable only.
void	setTraceAllMetas(boolean traceAllMetas) Select this option before indexing, then click "Add Properties from Traced Metas" to simplify creating new properties. The traced metas are stored in a separate database.
java.lang.String	toString() String representation of this DataModel.
DataModel	withDataModelClass(java.util.Collection<DataModelClass> __values)
DataModel	withDataModelClass(DataModelClass... __values) List of classes of this data model.
DataModel	withDataModelEnum(java.util.Collection<DataModelEnum> __values)
DataModel	withDataModelEnum(DataModelEnum... __values)
DataModel	withDefaultClass(java.lang.String defaultClass)
DataModel	withExpandNamedEntitiesLikeIn2014(boolean expandNamedEntitiesLikeIn2014)
DataModel	withExpandNamedEntitiesLikeIn2014(java.lang.Boolean expandNamedEntitiesLikeIn2014)
DataModel	withName(java.lang.String name)
DataModel	withPossibleLanguages(java.lang.String possibleLanguages)
DataModel	withSemanticType(java.util.Collection<SemanticType> __values)
DataModel	withSemanticType(SemanticType... __values) The list of semantic types of this data model. A semantic type defines the semantic analysis to perform, and can be assigned to 'alphanumeric' properties. The semantic types available out of the box are: text, identifier, meta, and url.
DataModel	withStoreAllMetas(boolean storeAllMetas)
DataModel	withStoreAllMetas(java.lang.Boolean storeAllMetas)
DataModel	withTraceAllMetas(boolean traceAllMetas)
DataModel	withTraceAllMetas(java.lang.Boolean traceAllMetas)
void	writeTo(java.io.OutputStream os) Write this DataModel as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

defaultClass

public java.lang.String defaultClass

dataModelEnum

public java.util.List<DataModelEnum> dataModelEnum

dataModelClass

public java.util.List<DataModelClass> dataModelClass

semanticType

public java.util.List<SemanticType> semanticType

possibleLanguages

public java.lang.String possibleLanguages

storeAllMetas

public boolean storeAllMetas

DEFAULT_STORE_ALL_METAS

public static final boolean DEFAULT_STORE_ALL_METAS

See Also:

Constant Field Values

traceAllMetas

public boolean traceAllMetas

DEFAULT_TRACE_ALL_METAS

public static final boolean DEFAULT_TRACE_ALL_METAS

See Also:

Constant Field Values

expandNamedEntitiesLikeIn2014

public boolean expandNamedEntitiesLikeIn2014

DEFAULT_EXPAND_NAMED_ENTITIES_LIKE_IN2014

public static final boolean DEFAULT_EXPAND_NAMED_ENTITIES_LIKE_IN2014

See Also:

Constant Field Values

Constructor Detail

DataModel

public DataModel()

DataModel

public DataModel(DataModel o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

Name of this Data Model.

getName

public java.lang.String getName()

Name of this Data Model.

withName

public DataModel withName(java.lang.String name)

setDefaultClass

public void setDefaultClass(java.lang.String defaultClass)

Default class to push documents when there is no "datamodel_class" papi directive, or no "TYPE" meta. Usually, all data model classes generate type-prefixed field names, like 'myclass_myproperty', except the defaultClass which has unprefixed fields in the expansion. The analysis pipeline deduces the data model class of a document by applying the following rules with this specific order:

1. Value of papi custom directive "datamodel_class" if any.
2. Value of papi meta "TYPE" if any.
3. Value of the default data model class of the connector pushing the document if any.
4. Use the data model class marked by the 'defaultClass' property.

getDefaultClass

public java.lang.String getDefaultClass()

Default class to push documents when there is no "datamodel_class" papi directive, or no "TYPE" meta. Usually, all data model classes generate type-prefixed field names, like 'myclass_myproperty', except the defaultClass which has unprefixed fields in the expansion. The analysis pipeline deduces the data model class of a document by applying the following rules with this specific order:

1. Value of papi custom directive "datamodel_class" if any.
2. Value of papi meta "TYPE" if any.
3. Value of the default data model class of the connector pushing the document if any.
4. Use the data model class marked by the 'defaultClass' property.

withDefaultClass

public DataModel withDefaultClass(java.lang.String defaultClass)

getDataModelEnum

public java.util.List<DataModelEnum> getDataModelEnum()

getDataModelEnumByName

public DataModelEnum getDataModelEnumByName(java.lang.String _lookup)

Get the DataModelEnum for which the name matches _lookup

Returns:

null if no matching DataModelEnum is found

getDataModelEnumAsMap

public java.util.Map<java.lang.String,DataModelEnum> getDataModelEnumAsMap()

Get the map of DataModelEnum, indexed by name

removeDataModelEnumByName

public boolean removeDataModelEnumByName(java.lang.String _lookup)

Removes the DataModelEnum for which the name matches _lookup

Returns:

false if no matching DataModelEnum is found, true if one was found

withDataModelEnum

public DataModel withDataModelEnum(DataModelEnum... __values)

withDataModelEnum

public DataModel withDataModelEnum(java.util.Collection<DataModelEnum> __values)

getDataModelClass

public java.util.List<DataModelClass> getDataModelClass()

List of classes of this data model.

getDataModelClassByName

public DataModelClass getDataModelClassByName(java.lang.String _lookup)

Get the DataModelClass for which the name matches _lookup

Returns:

null if no matching DataModelClass is found

getDataModelClassAsMap

public java.util.Map<java.lang.String,DataModelClass> getDataModelClassAsMap()

Get the map of DataModelClass, indexed by name

removeDataModelClassByName

public boolean removeDataModelClassByName(java.lang.String _lookup)

Removes the DataModelClass for which the name matches _lookup

Returns:

false if no matching DataModelClass is found, true if one was found

withDataModelClass

public DataModel withDataModelClass(DataModelClass... __values)

List of classes of this data model.

withDataModelClass

public DataModel withDataModelClass(java.util.Collection<DataModelClass> __values)

getSemanticType

public java.util.List<SemanticType> getSemanticType()

The list of semantic types of this data model.
A semantic type defines the semantic analysis to perform, and can be assigned to 'alphanumeric' properties.
The semantic types available out of the box are: text, identifier, meta, and url.

getSemanticTypeByName

public SemanticType getSemanticTypeByName(java.lang.String _lookup)

Get the SemanticType for which the name matches _lookup

Returns:

null if no matching SemanticType is found

getSemanticTypeAsMap

public java.util.Map<java.lang.String,SemanticType> getSemanticTypeAsMap()

Get the map of SemanticType, indexed by name

removeSemanticTypeByName

public boolean removeSemanticTypeByName(java.lang.String _lookup)

Removes the SemanticType for which the name matches _lookup

Returns:

false if no matching SemanticType is found, true if one was found

withSemanticType

public DataModel withSemanticType(SemanticType... __values)

The list of semantic types of this data model.
A semantic type defines the semantic analysis to perform, and can be assigned to 'alphanumeric' properties.
The semantic types available out of the box are: text, identifier, meta, and url.

withSemanticType

public DataModel withSemanticType(java.util.Collection<SemanticType> __values)

setPossibleLanguages

public void setPossibleLanguages(java.lang.String possibleLanguages)

The list of languages that can appear in the corpus.
Language detection will be restricted to this set.
A null value means that all languages are possible.

getPossibleLanguages

public java.lang.String getPossibleLanguages()

The list of languages that can appear in the corpus.
Language detection will be restricted to this set.
A null value means that all languages are possible.

withPossibleLanguages

public DataModel withPossibleLanguages(java.lang.String possibleLanguages)

setStoreAllMetas

public void setStoreAllMetas(boolean storeAllMetas)

Saves all metas that were not mapped to an index field or category as "csv encoded metas".
These metas are retrievable only. To make a meta searchable, create a data model property for it.

isStoreAllMetas

public boolean isStoreAllMetas()

Saves all metas that were not mapped to an index field or category as "csv encoded metas".
These metas are retrievable only. To make a meta searchable, create a data model property for it.

withStoreAllMetas

public DataModel withStoreAllMetas(boolean storeAllMetas)

withStoreAllMetas

public DataModel withStoreAllMetas(java.lang.Boolean storeAllMetas)

setTraceAllMetas

public void setTraceAllMetas(boolean traceAllMetas)

Select this option before indexing, then click "Add Properties from Traced Metas" to simplify creating new properties.
The traced metas are stored in a separate database. Once you have created properties based on traced metas, de-select this option to prevent the database from growing unnecessarily over time. Trace all metas pushed by connectors in order to ease property configuration.

isTraceAllMetas

public boolean isTraceAllMetas()

Select this option before indexing, then click "Add Properties from Traced Metas" to simplify creating new properties.
The traced metas are stored in a separate database. Once you have created properties based on traced metas, de-select this option to prevent the database from growing unnecessarily over time. Trace all metas pushed by connectors in order to ease property configuration.

withTraceAllMetas

public DataModel withTraceAllMetas(boolean traceAllMetas)

withTraceAllMetas

public DataModel withTraceAllMetas(java.lang.Boolean traceAllMetas)

setExpandNamedEntitiesLikeIn2014

public void setExpandNamedEntitiesLikeIn2014(boolean expandNamedEntitiesLikeIn2014)

isExpandNamedEntitiesLikeIn2014

public boolean isExpandNamedEntitiesLikeIn2014()

withExpandNamedEntitiesLikeIn2014

public DataModel withExpandNamedEntitiesLikeIn2014(boolean expandNamedEntitiesLikeIn2014)

withExpandNamedEntitiesLikeIn2014

public DataModel withExpandNamedEntitiesLikeIn2014(java.lang.Boolean expandNamedEntitiesLikeIn2014)

makeCopy

public DataModel makeCopy()

Creates and returns a deep copy of this DataModel.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DataModel.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DataModel.

Overrides:

toString in class java.lang.Object

check

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

Checks this DataModel.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

getClass

public DataModelClass getClass(java.lang.String name)

Get an existing class, returns null if it does not exist

getOrCreateClass

public DataModelClass getOrCreateClass(java.lang.String name)

Get a class, create it if it does not already exist

Returns:

the created or fetched object

addSignedProperty

public void addSignedProperty(java.lang.String className,
                              java.lang.String name)

Add a signed property to a class. The class must exist

addClass

public void addClass(DataModelClass classDef)