de.ipcon.schema

Class ArraySchemaTools

java.lang.Object

de.ipcon.schema.ArraySchemaTools

public class ArraySchemaTools
extends java.lang.Object

A collection of helper methods for namespaces with InstrumentedSchema for ArrayZeilenWrapper and -Delegates

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARRAY_COMPONENT_ENTITY_NAME
static java.lang.String	ARRAY_IMPLEMENTATION_PACKAGE
static java.lang.String	ARRAY_MANAGER_ENTITY_NAME
static java.lang.String	ARRAY_NAMESPACE_PREFIX
static java.lang.String	MANAGER_ALIAS_POSTFIX Name will be appended on the source array attribute name following the relation postfix, i.e.
static java.lang.String	VALUE_ALIAS

Method Summary

Modifier and Type	Method and Description
static void	assertArrayAttribute(AttributeI attr)
static AttributeI	createAlias(InstrumentingSchemaI schema, EntityI entity, WrappingArrayType type, java.lang.String name) Creates a new virtual property (alias) on the ArrayZeilenDelegate entity or a subentity to access and manipulate the component value of a source array.
static AttributeI	createAlias(InstrumentingSchemaI schema, EntityI entity, WrappingArrayType type, java.lang.String name, boolean isReadonly) Creates a new virtual property (alias) on the ArrayZeilenDelegate entity or a subentity to access and manipulate the component value of a source array.
static AttributeI	createManyrelationForDelegates(InstrumentingSchemaI schema, AttributeI wrapperAttr, EntityI typeEntity, java.lang.String manyRelName) Registers a new virtual many relation with the specified name, manyRelName, on the entity of the given wrapper attribute, returning instances of typeEntity.
static AttributeI	createManyrelationForDelegates(InstrumentingSchemaI schema, AttributeI wrapperAttr, EntityI typeEntity, java.lang.String manyRelName, boolean isReadOnly) Registers a new virtual many relation with the specified name, manyRelName, on the entity of the given wrapper attribute, returning instances of typeEntity.
static WrappingArrayType	getArrayAttributeType(AttributeI attr)
static java.lang.String	getNamespace(AttributeI arrayAttribute) Generates a unique namespace name to be used as name for the virtual entity of the ArrayZeilenDelegate, which uses this attribute as the only source array.
static java.lang.String	getNamespace(AttributeI[] attributes) Generates a unique but fixed namespace name for an ordered list of attributes
static boolean	isArrayAttribute(AttributeI attr)
static AttributeI	registerArrayNamespace(InstrumentingSchemaI schema, AttributeI arrayAttribute)
static AttributeI	registerArrayNamespace(InstrumentingSchemaI schema, AttributeI arrayAttribute, java.lang.String manyrelationName)
static AttributeI	registerArrayNamespace(InstrumentingSchemaI schema, AttributeI arrayAttribute, java.lang.String manyrelationName, java.lang.String namespace) Creates and registers the virtual entity and attribute modifications to access the components of an array as relation.

Methods inherited from class java.lang.Object

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

Field Detail

ARRAY_IMPLEMENTATION_PACKAGE

public static final java.lang.String ARRAY_IMPLEMENTATION_PACKAGE

See Also:

Constant Field Values

ARRAY_MANAGER_ENTITY_NAME

public static final java.lang.String ARRAY_MANAGER_ENTITY_NAME

See Also:

Constant Field Values

ARRAY_COMPONENT_ENTITY_NAME

public static final java.lang.String ARRAY_COMPONENT_ENTITY_NAME

See Also:

Constant Field Values

ARRAY_NAMESPACE_PREFIX

public static final java.lang.String ARRAY_NAMESPACE_PREFIX

See Also:

Constant Field Values

MANAGER_ALIAS_POSTFIX

public static final java.lang.String MANAGER_ALIAS_POSTFIX

Name will be appended on the source array attribute name following the relation postfix, i.e. [Array]AsRelationWrapper

See Also:

Constant Field Values

VALUE_ALIAS

public static final java.lang.String VALUE_ALIAS

See Also:

Constant Field Values

Method Detail

isArrayAttribute

public static boolean isArrayAttribute(AttributeI attr)

Returns:

true if attr is not null and represents an array

assertArrayAttribute

public static void assertArrayAttribute(AttributeI attr)

Throws:

an - IllegalArgumentException if and only if attr is not an array attribute

getArrayAttributeType

public static WrappingArrayType getArrayAttributeType(AttributeI attr)

Returns:

the WrappingArrayType for the provided array attribute

getNamespace

public static java.lang.String getNamespace(AttributeI arrayAttribute)

Generates a unique namespace name to be used as name for the virtual entity of the ArrayZeilenDelegate, which uses this attribute as the only source array.

See Also:

getNamespace(java.lang.String[], java.lang.String[])

getNamespace

public static java.lang.String getNamespace(AttributeI[] attributes)

Generates a unique but fixed namespace name for an ordered list of attributes

See Also:

getNamespace(java.lang.String[], java.lang.String[])

registerArrayNamespace

public static AttributeI registerArrayNamespace(InstrumentingSchemaI schema,
                                                AttributeI arrayAttribute)

See Also:

registerArrayNamespace(InstrumentingSchemaI, AttributeI, java.lang.String, java.lang.String)

registerArrayNamespace

public static AttributeI registerArrayNamespace(InstrumentingSchemaI schema,
                                                AttributeI arrayAttribute,
                                                java.lang.String manyrelationName)

See Also:

registerArrayNamespace(InstrumentingSchemaI, AttributeI, java.lang.String, java.lang.String)

registerArrayNamespace

public static AttributeI registerArrayNamespace(InstrumentingSchemaI schema,
                                                AttributeI arrayAttribute,
                                                java.lang.String manyrelationName,
                                                java.lang.String namespace)

Creates and registers the virtual entity and attribute modifications to access the components of an array as relation. Uses a ArrayZeilenWrapper with only this attribute as datasource. With the exception of the actual manyrelationName attribute, which isn't checked, all entities and attributes are not redefined if they already exist.

Parameters:

schema - the nonnull InstrumentingSchemaI to create the virtual entities with

arrayAttribute - the source attribute representing an array value

manyrelationName - the explicit name of the manyrelation that represents the arrayAttribute's values. Cannot exist on the array attributes entity name before calling this method. This method makes no guarantees whether an exception is thrown or the pre-existing attribute is simply returned.

namespace - the explicit name of the virtualEntity that will represent a single component value

Returns:

the created manyrelation attribute with this manyrelation name on the arrayAttributes entity.

createManyrelationForDelegates

public static AttributeI createManyrelationForDelegates(InstrumentingSchemaI schema,
                                                        AttributeI wrapperAttr,
                                                        EntityI typeEntity,
                                                        java.lang.String manyRelName)

Registers a new virtual many relation with the specified name, manyRelName, on the entity of the given wrapper attribute, returning instances of typeEntity. The wrapperAttr should be an n-1 relation returning the same, non-null ArrayZeilenWrapper instance per BO it is defined on. It is typically cached="SIMPLE". If wrapperAttr is null, then manyRelName is added directly to the ArrayZeilenWrapper entity and serves as an alias for the "zeilen" attribute.

Parameters:

schema - A non-null InstrumentingSchemaI to register a new virtual property on.

wrapperAttr - A nullable attribute of a n-1 relation returning an identical ArrayZeilenWrapper instance per bo.

typeEntity - The entity (or virtual entity) of the ArrayZeilenDelegate that will be returned.

manyRelName - A non-empty name for the created many relation.

Returns:

An attribute with the specified manyRelName on the wrapperAttrs entity, delegating getter, adder, and remover calls to the component wrapper.

createManyrelationForDelegates

public static AttributeI createManyrelationForDelegates(InstrumentingSchemaI schema,
                                                        AttributeI wrapperAttr,
                                                        EntityI typeEntity,
                                                        java.lang.String manyRelName,
                                                        boolean isReadOnly)

Registers a new virtual many relation with the specified name, manyRelName, on the entity of the given wrapper attribute, returning instances of typeEntity. The wrapperAttr should be an n-1 relation returning the same, non-null ArrayZeilenWrapper instance per BO it is defined on. It is typically cached="SIMPLE". If wrapperAttr is null, then manyRelName is added directly to the ArrayZeilenWrapper entity and serves as an alias for the "zeilen" attribute.

Parameters:

schema - A non-null InstrumentingSchemaI to register a new virtual property on.

wrapperAttr - A nullable attribute of a n-1 relation returning an identical ArrayZeilenWrapper instance per bo.

typeEntity - The entity (or virtual entity) of the ArrayZeilenDelegate that will be returned.

manyRelName - A non-empty name for the created many relation.

isReadOnly - if true, then the createdVirtualProperty will be read-only, i.e. doesn't allow adding or removing lines.

Returns:

An attribute with the specified manyRelName on the wrapperAttrs entity, delegating getter, adder, and remover calls to the component wrapper.

createAlias

public static AttributeI createAlias(InstrumentingSchemaI schema,
                                     EntityI entity,
                                     WrappingArrayType type,
                                     java.lang.String name)

Creates a new virtual property (alias) on the ArrayZeilenDelegate entity or a subentity to access and manipulate the component value of a source array. This method does not check if the alias is already registered and might fail if the alias name is already in use.

Parameters:

schema - The non-null schema where the virtual property 'alias' will be declared.

entity - The non-null entity, either the ArrayZeilenDelegate or one of its subentities.

type - The non-null type of the array that should be displayed. This information is needed by the GUI for formatting options.

name - The name of the alias/virtual property to create.

Returns:

An existing or newly created attribute with the specified name on the entity.

createAlias

public static AttributeI createAlias(InstrumentingSchemaI schema,
                                     EntityI entity,
                                     WrappingArrayType type,
                                     java.lang.String name,
                                     boolean isReadonly)

Creates a new virtual property (alias) on the ArrayZeilenDelegate entity or a subentity to access and manipulate the component value of a source array. This method does not check if the alias is already registered and might fail if the alias name is already in use.

Parameters:

schema - The non-null schema where the virtual property 'alias' will be declared.

entity - The non-null entity, either the ArrayZeilenDelegate or one of its subentities.

type - The non-null type of the array that should be displayed. This information is needed by the GUI for formatting options.

name - The name of the alias/virtual property to create.

isReadonly - If true, the alias will be read-only, meaning it can read from the source array but cannot modify it. Defaults to false, indicating read/write access.

Returns:

An existing or newly created attribute with the specified name on the entity.