com.exalead.mercury.component.config.descriptor

Class DataModelClassField

java.lang.Object

com.exalead.mercury.component.config.descriptor.Item

com.exalead.mercury.component.config.descriptor.Field

com.exalead.mercury.component.config.descriptor.DataModelClassField

All Implemented Interfaces:

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

public class DataModelClassField
extends Field
implements com.exalead.util.Checkable, java.io.Serializable

A data model class. If both parameters are null, then use the data model specified in the component's build-group if any.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	buildGroup
java.lang.String	dataModel

Fields inherited from class com.exalead.mercury.component.config.descriptor.Field

allowEmpty, DEFAULT_ALLOW_EMPTY, defaultValue

Fields inherited from class com.exalead.mercury.component.config.descriptor.Item

DEFAULT_IS_HIDDEN, DEFAULT_IS_MANDATORY, description, isHidden, isMandatory, name, ordering, title

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DataModelClassField.
static DataModelClassField	fromString(java.lang.String s) String representation of this DataModelClassField.
java.lang.String	getBuildGroup() If not null, then use the data model of the specified build-group.
java.lang.String	getDataModel() If not null, then use the specified data model.
DataModelClassField	makeCopy() Creates and returns a deep copy of this DataModelClassField.
static DataModelClassField	readFrom(java.io.InputStream is) Read this DataModelClassField from an XML fragment.
void	setBuildGroup(java.lang.String buildGroup) If not null, then use the data model of the specified build-group.
void	setDataModel(java.lang.String dataModel) If not null, then use the specified data model.
java.lang.String	toString() String representation of this DataModelClassField.
DataModelClassField	withAllowEmpty(boolean allowEmpty)
DataModelClassField	withAllowEmpty(java.lang.Boolean allowEmpty)
DataModelClassField	withBuildGroup(java.lang.String buildGroup)
DataModelClassField	withDataModel(java.lang.String dataModel)
DataModelClassField	withDefaultValue(java.lang.String defaultValue)
DataModelClassField	withDescription(java.lang.String description)
DataModelClassField	withIsHidden(boolean isHidden)
DataModelClassField	withIsHidden(java.lang.Boolean isHidden)
DataModelClassField	withIsMandatory(boolean isMandatory)
DataModelClassField	withIsMandatory(java.lang.Boolean isMandatory)
DataModelClassField	withName(java.lang.String name)
DataModelClassField	withOrdering(int ordering)
DataModelClassField	withOrdering(java.lang.Integer ordering)
DataModelClassField	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this DataModelClassField as an XML fragment

Methods inherited from class com.exalead.mercury.component.config.descriptor.Field

getDefaultValue, isAllowEmpty, setAllowEmpty, setDefaultValue

Methods inherited from class com.exalead.mercury.component.config.descriptor.Item

getDescription, getName, getOrdering, getTitle, isIsHidden, isIsMandatory, setDescription, setIsHidden, setIsMandatory, setName, setOrdering, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

dataModel

public java.lang.String dataModel

buildGroup

public java.lang.String buildGroup

Constructor Detail

DataModelClassField

public DataModelClassField()

DataModelClassField

public DataModelClassField(DataModelClassField o)

Copy constructor

Method Detail

withDefaultValue

public DataModelClassField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class Field

withAllowEmpty

public DataModelClassField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withAllowEmpty

public DataModelClassField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withName

public DataModelClassField withName(java.lang.String name)

Overrides:

withName in class Field

withTitle

public DataModelClassField withTitle(java.lang.String title)

Overrides:

withTitle in class Field

withDescription

public DataModelClassField withDescription(java.lang.String description)

Overrides:

withDescription in class Field

withIsMandatory

public DataModelClassField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsMandatory

public DataModelClassField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsHidden

public DataModelClassField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Field

withIsHidden

public DataModelClassField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Field

withOrdering

public DataModelClassField withOrdering(int ordering)

Overrides:

withOrdering in class Field

withOrdering

public DataModelClassField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Field

setDataModel

public void setDataModel(java.lang.String dataModel)

If not null, then use the specified data model.

getDataModel

public java.lang.String getDataModel()

If not null, then use the specified data model.

withDataModel

public DataModelClassField withDataModel(java.lang.String dataModel)

setBuildGroup

public void setBuildGroup(java.lang.String buildGroup)

If not null, then use the data model of the specified build-group.

getBuildGroup

public java.lang.String getBuildGroup()

If not null, then use the data model of the specified build-group.

withBuildGroup

public DataModelClassField withBuildGroup(java.lang.String buildGroup)

makeCopy

public DataModelClassField makeCopy()

Creates and returns a deep copy of this DataModelClassField.

Overrides:

makeCopy in class Field

readFrom

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

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

Overrides:

writeTo in class Field

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DataModelClassField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DataModelClassField.

Overrides:

toString in class Field

check

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

Checks this DataModelClassField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Field

Throws:

com.exalead.util.TypedException