Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomIncludeOptions

java.lang.Object

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

de.espirit.firstspirit.access.store.templatestore.gom.GomIncludeOptions

All Implemented Interfaces:

OptionFactoryProvider, GomCheckable, GomElement, GomIncludeConfiguration, GomPolymorphic, Serializable

@NonExtendable
public class GomIncludeOptions
extends AbstractGomElement
implements GomIncludeConfiguration, GomPolymorphic, OptionFactoryProvider, GomCheckable

GOM definition for inclusion. The enumeration GomIncludeOptions.IncludeVariant defines the supported types of includes.

Since:

4.2.3

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GomIncludeOptions.EmptyConfiguration	Empty configuration.
static enum	GomIncludeOptions.IncludeVariant	Variants to include

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable

GomCheckable.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG	The tag of this component

Constructor Summary

Constructors

Constructor	Description
GomIncludeOptions()

Method Summary

Modifier and Type	Method	Description
protected String	getDefaultTag()	Return the default tag for a gom element.
String	getGuiXml()	Get the GuiXML to be included.
GomLabelExpressions	getLabels()	Language-dependent expressions for producing labels
List<GomElement>	getMixins()	Get the list of mixed in elements.
OptionFactory	getOptionFactory()	Get a factory for accessing options defined by the include mechanism.
IncludeType	getType()	Type of inclusion
void	setType(IncludeType value)	Sets the type of inclusion
void	validate(GomCheckable.Context context)	Validate the element against the given context.
void	verify()	Verify the element to be fulfill its syntactic constraints.

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Field Details

TAG

public static final String TAG

The tag of this component

Since:

4.2.3

See Also:

• Constant Field Values

Constructor Details

GomIncludeOptions

public GomIncludeOptions()

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomElement

Return the default tag for a gom element.

Specified by:

getDefaultTag in class AbstractGomElement

Returns:

The elements default tag.

getType

public IncludeType getType()

Type of inclusion

Since:

4.2.3

setType

public void setType(IncludeType value)

Sets the type of inclusion

Since:

4.2.3

getLabels

public GomLabelExpressions getLabels()

Language-dependent expressions for producing labels

Since:

4.2.5

getMixins

public List<GomElement> getMixins()
                           throws ConfigurationException

Description copied from interface: GomPolymorphic

Get the list of mixed in elements. Note that the order of mixins returned in the list defines the mixin being chosen for a value. That is, if two or more mixins use the same name for an element, the first mixin of the list will win.

Specified by:

getMixins in interface GomPolymorphic

Returns:

A list of mixins.

Throws:

ConfigurationException - if the configuration for providing mixins is incorrect.

getGuiXml

public String getGuiXml()

Description copied from interface: GomIncludeConfiguration

Get the GuiXML to be included.

Specified by:

getGuiXml in interface GomIncludeConfiguration

Returns:

The included GuiXML.

verify

public void verify()
            throws IllegalStateException

Description copied from interface: GomCheckable

Verify the element to be fulfill its syntactic constraints.

Specified by:

verify in interface GomCheckable

Throws:

IllegalStateException - If the element is not correctly set up.

validate

public void validate(GomCheckable.Context context)
              throws GomValidationError

Description copied from interface: GomCheckable

Validate the element against the given context.

Specified by:

validate in interface GomCheckable

Parameters:

context - The context to validate for.

Throws:

GomValidationError - If the element is not plausible wrt. its context.

getOptionFactory

public OptionFactory getOptionFactory()

Get a factory for accessing options defined by the include mechanism.

Specified by:

getOptionFactory in interface OptionFactoryProvider

Returns:

The factory.