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

Class GomQuery

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList<GomParamImpl>

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

All Implemented Interfaces:

GomCheckable, GomElement, GomList<GomParamImpl>, GomUidProviding, GomUidTypeProviding, Serializable, Cloneable, Iterable<GomParamImpl>, Collection<GomParamImpl>, List<GomParamImpl>, RandomAccess

@NonExtendable
public class GomQuery
extends AbstractGomList<GomParamImpl>
implements GomCheckable, GomUidProviding, GomUidTypeProviding

GOM representation of a query

Since:

4.2.410

See Also:

• Serialized Form

Nested Class Summary

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
GomQuery()

Method Summary

Modifier and Type	Method	Description
protected String	getDefaultTag()	Returns the default tag name of the component.
Map<String,Class<? extends GomElement>>	getGomElementMappings()	Get a list of mappings from tag name to class supported by this list.
String	getName()	Uid of the query
@Nullable String	getUid()	The UID this element holds as a reference.
IDProvider.UidType	getUidType()	The IDProvider.UidType of the references contained.
void	setName(String queryUid)	Sets the uid of the query
void	validate(GomCheckable.Context context)	Validate the element against the given context.
void	verify()	Check if the list is marked as mandatory (not inherited!)

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Field Details

TAG

public static final String TAG

The tag of this component

Since:

4.2.410

See Also:

• Constant Field Values

Constructor Details

GomQuery

public GomQuery()

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomList

Returns the default tag name of the component.

Specified by:

getDefaultTag in class AbstractGomList<GomParamImpl>

getName

public String getName()

Uid of the query

Since:

4.2.410

setName

public void setName(String queryUid)

Sets the uid of the query

Since:

4.2.410

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<GomParamImpl>

Overrides:

getGomElementMappings in class AbstractGomList<GomParamImpl>

Returns:

The list of child tags.

verify

public void verify()
            throws IllegalStateException

Description copied from class: AbstractGomList

Check if the list is marked as mandatory (not inherited!) and not empty

Specified by:

verify in interface GomCheckable

Overrides:

verify in class AbstractGomList<GomParamImpl>

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.

getUid

@Nullable
public @Nullable String getUid()

Description copied from interface: GomUidProviding

The UID this element holds as a reference.

Specified by:

getUid in interface GomUidProviding

Returns:

The UID or null.

getUidType

@Nullable
public IDProvider.UidType getUidType()

Description copied from interface: GomUidTypeProviding

The IDProvider.UidType of the references contained.

Specified by:

getUidType in interface GomUidTypeProviding

Returns:

The associated uid type.