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

Class GomModule

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<GomElement>

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

All Implemented Interfaces:

GomCheckable, GomEditorProvider, GomElement, GomList<GomElement>, SpecialistsEmployer, Serializable, Iterable<GomElement>, Collection<GomElement>, List<GomElement>

Direct Known Subclasses:

GomGroup

@NonExtendable
public class GomModule
extends AbstractList<GomElement>
implements GomEditorProvider, GomCheckable, SpecialistsEmployer

Default GOM module implementation.

Since:

4.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GomModule.Kind	The module kind

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

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
GomModule()	Creates a new instance

Method Summary

Modifier and Type	Method	Description
void	add(int index, GomElement element)
@NotNull List<String>	appendEditorNames(@Nullable List<String> names)	Append the names of all local and children's editors to the given list of names and return the list.
boolean	equals(Object o)
@Nullable GomFormElement	findEditor(String name)	Look up a GOM editor element within this provider.
@NotNull Iterable<GomFormElement>	forms()	Returns an iterable on all form elements within this provider.
GomElement	get(int index)	Getter for GomElements.
Map<String,Class<? extends GomElement>>	getGomElementMappings()	Get a list of mappings from tag name to class supported by this list.
String	getGomElementTag()	Get the tag name, the instance was produced for.
GomIncludeConfiguration	getIncludeConfiguration()	Get the configuration, if this is an included element.
@NotNull GomModule	getMonoglotVariant()
SpecialistsBroker	getSpecialistsBroker()	Returns the broker
String	getUid()	Get the unique identifier of this provider.
int	hashCode()
boolean	hasRepresentation()	Indicates, that the element has a representation to be displayed in a form. A representation usually corresponds to a registered editor component.
GomElement	remove(int index)
GomElement	set(int index, GomElement element)
void	setDefaults(Data data)	Set the default values for all editors based on the given data.
void	setFormDefaults(@Nullable FormData formData)	Set the default values for all editors based on the given form data.
void	setGomElementTag(@NotNull String name)	Sets the tag name, the instance gets produced for.
void	setIncludeConfiguration(GomIncludeConfiguration includeConfiguration)	Set the configuration for an included element.
final void	setSpecialistsBroker(@NotNull SpecialistsBroker specialistsBroker)	Set the broker to be used by this employer.
void	setUid(String uid)	Set the unique identifier for this provider.
int	size()
void	validate(GomCheckable.Context context)	Validate the element against the given context.
void	verify()	Verify the element to be fulfill its syntactic constraints.
static GomModule	with(SpecialistsBroker specialistsBroker, GomElement... elements)	Creates a new instance containing the given elements

Methods inherited from class java.util.AbstractList

add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, addAll, addAll, clear, contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, replaceAll, retainAll, sort, spliterator, subList, toArray, toArray

Field Details

TAG

public static final String TAG

The tag of this component

Since:

4.0

See Also:

• Constant Field Values

Constructor Details

GomModule

public GomModule()

Creates a new instance

Since:

4.0

Method Details

with

public static GomModule with(SpecialistsBroker specialistsBroker,
 GomElement... elements)

Creates a new instance containing the given elements

Since:

4.0

setSpecialistsBroker

public final void setSpecialistsBroker(@NotNull
 @NotNull SpecialistsBroker specialistsBroker)

Description copied from interface: SpecialistsEmployer

Set the broker to be used by this employer.

Specified by:

setSpecialistsBroker in interface SpecialistsEmployer

Parameters:

specialistsBroker - The specialists broker.

get

public GomElement get(int index)

Description copied from interface: GomEditorProvider

Getter for GomElements.

Specified by:

get in interface GomEditorProvider

Specified by:

get in interface List<GomElement>

Specified by:

get in class AbstractList<GomElement>

size

public int size()

Specified by:

size in interface Collection<GomElement>

Specified by:

size in interface List<GomElement>

Specified by:

size in class AbstractCollection<GomElement>

set

public GomElement set(int index,
 GomElement element)

Specified by:

set in interface List<GomElement>

Overrides:

set in class AbstractList<GomElement>

add

public void add(int index,
 GomElement element)

Specified by:

add in interface List<GomElement>

Overrides:

add in class AbstractList<GomElement>

remove

public GomElement remove(int index)

Specified by:

remove in interface List<GomElement>

Overrides:

remove in class AbstractList<GomElement>

getSpecialistsBroker

public SpecialistsBroker getSpecialistsBroker()

Returns the broker

Since:

4.2.105

getGomElementTag

public String getGomElementTag()

Description copied from interface: GomElement

Get the tag name, the instance was produced for.

Specified by:

getGomElementTag in interface GomElement

Returns:

The name of the tag.

setGomElementTag

public void setGomElementTag(@NotNull
 @NotNull String name)

Description copied from interface: GomElement

Sets the tag name, the instance gets produced for.

Specified by:

setGomElementTag in interface GomElement

Parameters:

name - The name of the tag.

hasRepresentation

public boolean hasRepresentation()

Description copied from interface: GomElement

Indicates, that the element has a representation to be displayed in a form.
A representation usually corresponds to a registered editor component.

Specified by:

hasRepresentation in interface GomElement

Returns:

true, if a representation is available.

getUid

public String getUid()

Description copied from interface: GomEditorProvider

Get the unique identifier of this provider.

Specified by:

getUid in interface GomEditorProvider

Returns:

The provider's UID.

setUid

public void setUid(String uid)

Description copied from interface: GomEditorProvider

Set the unique identifier for this provider.

Specified by:

setUid in interface GomEditorProvider

Parameters:

uid - The identifier to be used for this provider.

getIncludeConfiguration

public GomIncludeConfiguration getIncludeConfiguration()

Description copied from interface: GomElement

Get the configuration, if this is an included element.

Specified by:

getIncludeConfiguration in interface GomElement

Returns:

The configuration for including the element.

setIncludeConfiguration

public void setIncludeConfiguration(GomIncludeConfiguration includeConfiguration)

Description copied from interface: GomElement

Set the configuration for an included element.

Specified by:

setIncludeConfiguration in interface GomElement

Parameters:

includeConfiguration - The configuration to set.

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, must not be null.

Throws:

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

findEditor

@Nullable
public @Nullable GomFormElement findEditor(String name)

Description copied from interface: GomEditorProvider

Look up a GOM editor element within this provider.

Specified by:

findEditor in interface GomEditorProvider

Parameters:

name - The name of the editor.

Returns:

The matching editor or null.

appendEditorNames

@NotNull
public @NotNull List<String> appendEditorNames(@Nullable
 @Nullable List<String> names)

Description copied from interface: GomEditorProvider

Append the names of all local and children's editors to the given list of names and return the list. If names is null, returns a new list.

Specified by:

appendEditorNames in interface GomEditorProvider

Parameters:

names - A list of names or null.

Returns:

The list of editor names, maybe empty.

forms

@NotNull
public @NotNull Iterable<GomFormElement> forms()

Description copied from interface: GomEditorProvider

Returns an iterable on all form elements within this provider.

Specified by:

forms in interface GomEditorProvider

Returns:

A list of form elements, maybe empty.

setDefaults

public void setDefaults(Data data)

Description copied from interface: GomEditorProvider

Set the default values for all editors based on the given data.

Specified by:

setDefaults in interface GomEditorProvider

Parameters:

data - The data providing default values.

setFormDefaults

public void setFormDefaults(@Nullable
 @Nullable FormData formData)

Description copied from interface: GomEditorProvider

Set the default values for all editors based on the given form data.

Specified by:

setFormDefaults in interface GomEditorProvider

Parameters:

formData - The form data providing default values.

getMonoglotVariant

@NotNull
public @NotNull GomModule getMonoglotVariant()

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<GomElement>

Specified by:

equals in interface List<GomElement>

Overrides:

equals in class AbstractList<GomElement>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<GomElement>

Specified by:

hashCode in interface List<GomElement>

Overrides:

hashCode in class AbstractList<GomElement>

getGomElementMappings

public Map<String,Class<? extends GomElement>> getGomElementMappings()

Description copied from interface: GomList

Get a list of mappings from tag name to class supported by this list.

Convention:

The mapping shall only be created on demand and not change at runtime.

Specified by:

getGomElementMappings in interface GomList<GomElement>

Returns:

The list of child tags.