com.exalead.datamodel.v10

Class DataModelEnum

java.lang.Object

com.exalead.datamodel.v10.DataModelEnum

All Implemented Interfaces:

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

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

A custom enum allows you to define a closed list of values for a property.
Note that i18n is not implemented.

This option is not recommended.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<DataModelEnumElement>	dataModelEnumElement
static int	DEFAULT_DEFAULT_VALUE
static boolean	DEFAULT_STRICT
int	defaultValue
java.util.List<Label>	label
java.lang.String	name
boolean	strict

Constructor Summary

Constructors

Constructor and Description
DataModelEnum()
DataModelEnum(DataModelEnum o) Copy constructor
DataModelEnum(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addElement(DataModelEnumElement element)
void	check(boolean deep, java.lang.String errorContext) Checks this DataModelEnum.
static DataModelEnum	fromString(java.lang.String s) String representation of this DataModelEnum.
java.util.List<DataModelEnumElement>	getDataModelEnumElement() Possible values for the enum.
int	getDefaultValue() Index of default value in the elements list. -1 = no default value for property
java.util.List<Label>	getLabel() Labels for i18n.
java.lang.String	getName()
boolean	isStrict() If strict, this data type will only accept values listed in elements. Warning: This is not implemented for the moment.
DataModelEnum	makeCopy() Creates and returns a deep copy of this DataModelEnum.
static DataModelEnum	readFrom(java.io.InputStream is) Read this DataModelEnum from an XML fragment.
void	setDefaultValue(int defaultValue) Index of default value in the elements list. -1 = no default value for property
void	setName(java.lang.String name)
void	setStrict(boolean strict) If strict, this data type will only accept values listed in elements. Warning: This is not implemented for the moment.
java.lang.String	toString() String representation of this DataModelEnum.
DataModelEnum	withDataModelEnumElement(java.util.Collection<DataModelEnumElement> __values)
DataModelEnum	withDataModelEnumElement(DataModelEnumElement... __values) Possible values for the enum.
DataModelEnum	withDefaultValue(int defaultValue)
DataModelEnum	withDefaultValue(java.lang.Integer defaultValue)
DataModelEnum	withLabel(java.util.Collection<Label> __values)
DataModelEnum	withLabel(Label... __values) Labels for i18n.
DataModelEnum	withName(java.lang.String name)
DataModelEnum	withStrict(boolean strict)
DataModelEnum	withStrict(java.lang.Boolean strict)
void	writeTo(java.io.OutputStream os) Write this DataModelEnum 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

dataModelEnumElement

public java.util.List<DataModelEnumElement> dataModelEnumElement

strict

public boolean strict

DEFAULT_STRICT

public static final boolean DEFAULT_STRICT

See Also:

Constant Field Values

defaultValue

public int defaultValue

DEFAULT_DEFAULT_VALUE

public static final int DEFAULT_DEFAULT_VALUE

See Also:

Constant Field Values

label

public java.util.List<Label> label

Constructor Detail

DataModelEnum

public DataModelEnum()

DataModelEnum

public DataModelEnum(DataModelEnum o)

Copy constructor

DataModelEnum

public DataModelEnum(java.lang.String name)

Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

withName

public DataModelEnum withName(java.lang.String name)

getDataModelEnumElement

public java.util.List<DataModelEnumElement> getDataModelEnumElement()

Possible values for the enum.

withDataModelEnumElement

public DataModelEnum withDataModelEnumElement(DataModelEnumElement... __values)

Possible values for the enum.

withDataModelEnumElement

public DataModelEnum withDataModelEnumElement(java.util.Collection<DataModelEnumElement> __values)

setStrict

public void setStrict(boolean strict)

If strict, this data type will only accept values listed in elements.
Warning: This is not implemented for the moment.

isStrict

public boolean isStrict()

If strict, this data type will only accept values listed in elements.
Warning: This is not implemented for the moment.

withStrict

public DataModelEnum withStrict(boolean strict)

withStrict

public DataModelEnum withStrict(java.lang.Boolean strict)

setDefaultValue

public void setDefaultValue(int defaultValue)

Index of default value in the elements list.
-1 = no default value for property

getDefaultValue

public int getDefaultValue()

Index of default value in the elements list.
-1 = no default value for property

withDefaultValue

public DataModelEnum withDefaultValue(int defaultValue)

withDefaultValue

public DataModelEnum withDefaultValue(java.lang.Integer defaultValue)

getLabel

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

Labels for i18n. TODO not implemented

withLabel

public DataModelEnum withLabel(Label... __values)

Labels for i18n. TODO not implemented

withLabel

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

makeCopy

public DataModelEnum makeCopy()

Creates and returns a deep copy of this DataModelEnum.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DataModelEnum.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DataModelEnum.

Overrides:

toString in class java.lang.Object

check

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

Checks this DataModelEnum.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

addElement

public void addElement(DataModelEnumElement element)