com.exalead.datamodel.v10

Class DataModelClass

java.lang.Object

com.exalead.datamodel.v10.DataModelClass

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<DynamicProperty>	dynamicProperty
ExpansionParams	expansionParams
java.util.List<Label>	label
java.lang.String	name
java.lang.String	parentClass
java.util.List<Property>	property

Constructor Summary

Constructors

Constructor and Description
DataModelClass()
DataModelClass(DataModelClass o) Copy constructor
DataModelClass(java.lang.String name)
DataModelClass(java.lang.String name, java.lang.String parentClass)

Method Summary

Modifier and Type	Method and Description
<T extends DynamicProperty> T	addDynamicProperty(T p)
AlphanumProperty	addFacetOnlyAlphanumProperty(java.lang.String name, java.lang.String textType)
AlphanumProperty	addFacetOnlyAlphanumProperty(java.lang.String name, java.lang.String forcedRoot, java.lang.String textType)
GeoProperty	addGeoProperty(java.lang.String name)
AlphanumProperty	addNonDedicatedAlphanumProperty(java.lang.String name, java.lang.String textType)
<T extends Property> T	addProperty(T p)
AlphanumProperty	addRetrievableOnlyAlphanumProperty(java.lang.String name, java.lang.String textType)
AlphanumProperty	addSearchableOnlyAlphanumProperty(java.lang.String name, java.lang.String textType)
NumericalProperty	addSignedProperty(java.lang.String name)
AlphanumProperty	addStandardAlphanumProperty(java.lang.String name) Deprecated.
AlphanumProperty	addStandardAlphanumProperty(java.lang.String name, java.lang.String textType)
NumericalProperty	addUnsignedProperty(java.lang.String name)
void	check(boolean deep, java.lang.String errorContext) Checks this DataModelClass.
static DataModelClass	fromString(java.lang.String s) String representation of this DataModelClass.
java.util.List<DynamicProperty>	getDynamicProperty() The dynamic properties of the class.
ExpansionParams	getExpansionParams()
java.util.List<Label>	getLabel() Labels for i18n.
java.lang.String	getName()
java.lang.String	getParentClass() The parent class name.
java.util.List<Property>	getProperty() The properties of the class.
Property	getProperty(java.lang.String name)
java.util.Map<java.lang.String,Property>	getPropertyAsMap() Get the map of Property, indexed by name
Property	getPropertyByName(java.lang.String _lookup) Get the Property for which the name matches _lookup
DataModelClass	makeCopy() Creates and returns a deep copy of this DataModelClass.
static DataModelClass	readFrom(java.io.InputStream is) Read this DataModelClass from an XML fragment.
boolean	removePropertyByName(java.lang.String _lookup) Removes the Property for which the name matches _lookup
void	setExpansionParams(ExpansionParams expansionParams)
void	setName(java.lang.String name)
void	setParentClass(java.lang.String parentClass) The parent class name.
java.lang.String	toString() String representation of this DataModelClass.
DataModelClass	withDynamicProperty(java.util.Collection<DynamicProperty> __values)
DataModelClass	withDynamicProperty(DynamicProperty... __values) The dynamic properties of the class.
DataModelClass	withExpansionParams(ExpansionParams expansionParams)
DataModelClass	withLabel(java.util.Collection<Label> __values)
DataModelClass	withLabel(Label... __values) Labels for i18n.
DataModelClass	withName(java.lang.String name)
DataModelClass	withParentClass(java.lang.String parentClass)
DataModelClass	withProperty(java.util.Collection<Property> __values)
DataModelClass	withProperty(Property... __values) The properties of the class.
void	writeTo(java.io.OutputStream os) Write this DataModelClass 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

parentClass

public java.lang.String parentClass

expansionParams

public ExpansionParams expansionParams

property

public java.util.List<Property> property

dynamicProperty

public java.util.List<DynamicProperty> dynamicProperty

label

public java.util.List<Label> label

Constructor Detail

DataModelClass

public DataModelClass()

DataModelClass

public DataModelClass(DataModelClass o)

Copy constructor

DataModelClass

public DataModelClass(java.lang.String name)

DataModelClass

public DataModelClass(java.lang.String name,
                      java.lang.String parentClass)

Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

withName

public DataModelClass withName(java.lang.String name)

setParentClass

public void setParentClass(java.lang.String parentClass)

The parent class name. May be null if this class has no parent class.

getParentClass

public java.lang.String getParentClass()

The parent class name. May be null if this class has no parent class.

withParentClass

public DataModelClass withParentClass(java.lang.String parentClass)

setExpansionParams

public void setExpansionParams(ExpansionParams expansionParams)

getExpansionParams

public ExpansionParams getExpansionParams()

withExpansionParams

public DataModelClass withExpansionParams(ExpansionParams expansionParams)

getProperty

public java.util.List<Property> getProperty()

The properties of the class.

getPropertyByName

public Property getPropertyByName(java.lang.String _lookup)

Get the Property for which the name matches _lookup

Returns:

null if no matching Property is found

getPropertyAsMap

public java.util.Map<java.lang.String,Property> getPropertyAsMap()

Get the map of Property, indexed by name

removePropertyByName

public boolean removePropertyByName(java.lang.String _lookup)

Removes the Property for which the name matches _lookup

Returns:

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

withProperty

public DataModelClass withProperty(Property... __values)

The properties of the class.

withProperty

public DataModelClass withProperty(java.util.Collection<Property> __values)

getDynamicProperty

public java.util.List<DynamicProperty> getDynamicProperty()

The dynamic properties of the class.

withDynamicProperty

public DataModelClass withDynamicProperty(DynamicProperty... __values)

The dynamic properties of the class.

withDynamicProperty

public DataModelClass withDynamicProperty(java.util.Collection<DynamicProperty> __values)

getLabel

public java.util.List<Label> getLabel()

Labels for i18n. TODO not implemented

withLabel

public DataModelClass withLabel(Label... __values)

Labels for i18n. TODO not implemented

withLabel

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

makeCopy

public DataModelClass makeCopy()

Creates and returns a deep copy of this DataModelClass.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DataModelClass.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DataModelClass.

Overrides:

toString in class java.lang.Object

check

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

Checks this DataModelClass.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

addProperty

public <T extends Property> T addProperty(T p)

addDynamicProperty

public <T extends DynamicProperty> T addDynamicProperty(T p)

addSignedProperty

public NumericalProperty addSignedProperty(java.lang.String name)

addUnsignedProperty

public NumericalProperty addUnsignedProperty(java.lang.String name)

addStandardAlphanumProperty

@Deprecated
public AlphanumProperty addStandardAlphanumProperty(java.lang.String name)

Deprecated.

addStandardAlphanumProperty

public AlphanumProperty addStandardAlphanumProperty(java.lang.String name,
                                                    java.lang.String textType)

addSearchableOnlyAlphanumProperty

public AlphanumProperty addSearchableOnlyAlphanumProperty(java.lang.String name,
                                                          java.lang.String textType)

addFacetOnlyAlphanumProperty

public AlphanumProperty addFacetOnlyAlphanumProperty(java.lang.String name,
                                                     java.lang.String textType)

addFacetOnlyAlphanumProperty

public AlphanumProperty addFacetOnlyAlphanumProperty(java.lang.String name,
                                                     java.lang.String forcedRoot,
                                                     java.lang.String textType)

addRetrievableOnlyAlphanumProperty

public AlphanumProperty addRetrievableOnlyAlphanumProperty(java.lang.String name,
                                                           java.lang.String textType)

addNonDedicatedAlphanumProperty

public AlphanumProperty addNonDedicatedAlphanumProperty(java.lang.String name,
                                                        java.lang.String textType)

addGeoProperty

public GeoProperty addGeoProperty(java.lang.String name)

getProperty

public Property getProperty(java.lang.String name)