de.ipcon.schema

Class SchemaTools

java.lang.Object

de.ipcon.schema.SchemaTools

public class SchemaTools
extends java.lang.Object

Classic tools collection, full of static methods that are constantly used in the schema context, such as finding attributes in polymorphic entities etc.

Method Summary

Modifier and Type	Method and Description
static void	addRelationObject(SchemaI schema, java.lang.Object bo, java.lang.String attPath, java.lang.Object addMe) Adds the given relations to the attribute of a given bo specified by the attributepath
static void	addSingleAttributeRelationObject(EntityI entity, java.lang.Object bo, java.lang.String attributeName, java.lang.Object value) Adds the given value as relational object to the given attribute of the given bo
static void	addSingleAttributeRelationObject(SchemaI schema, java.lang.Object bo, java.lang.String attributeName, java.lang.Object value) Adds the given value as relational object to the given attribute of the given bo
static void	checkSyntacticallyValidAttPath(java.lang.String attrPath)
static java.util.Collection	collectValues(SchemaI schema, BOI bo, java.lang.String attPath) Collects all values for the last attribute in the given attribute path, resolving the many-relations in the path.
static java.util.Collection	collectValues(SchemaI schema, BOI bo, java.lang.String attPath, boolean nullIfNullOnPath) Collects all values for the last attribute in the given attribute path, resolving the many-relations in the path.
static java.util.Collection	collectValues(SchemaI schema, BOI bo, java.lang.String attPath, boolean nullIfNullOnPath, boolean nullIfAttrMissingOnPath) Collects all values for the last attribute in the given attribute path, resolving the many-relations in the path.
static void	debug(java.lang.String msg) Convenience method for logging (log debug messages)
static void	debug(java.lang.String msg, java.lang.Throwable cause) Convenience method for logging (log debug messages)
static java.lang.String	determineProjectBasePackageName(SchemaI schema) This method tries to determine the name of the "base package" of a project from the package/classnames of the EntityIs in the given SchemaI.
static java.lang.String[]	determineProjectPackageNames(SchemaI _schema) Determinates the ProjectPackageNames from a given Schema by iterating the entitylist and adding the entity packages
static java.util.Map	entitiesToClasses(java.util.Collection entities) Maps the provided EntityI objects into an IdentityHashMap with EntityI#getClazz() as their values.
static AttributeI[]	getAllPossibleRelationsTo(EntityI ent) Returns all persistent AttributeI-s possibly referring to a given EntityI (or one of it's super classes), even if they're marked as ignoreBackRelation.
static java.util.List	getAllRelations(EntityI entity) Returns a List of all attributes of the given entity which are relations, including the attributes from entity bases
static AnnotatedValue	getAnnotatedValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath) Tries to retrieve the value for the given attribute (chain) from the specified BO using the provided SchemaI.
static AnnotatedValue	getAnnotatedValue(SchemaI schema, java.lang.Object bo, java.lang.String[] attPath) Tries to retrieve the value for the given attribute path from the specified BO using the provided SchemaI.
static AnnotatedValue	getAnnotatedValue(SchemaI schema, java.lang.Object bo, java.lang.String[] attPath, boolean assumeOnlySingleRelations) Tries to retrieve the value for the given attribute path from the specified BO using the provided SchemaI.
static AnnotatedValue	getAnnotatedValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath, boolean assumeOnlySingleRelations) Tries to retrieve the value for the given attribute (chain) from the specified BO using the provided SchemaI.
static AnnotatedValue	getAnnotatedValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attPath) Tries to get the value for given the attribute (chain) for the given BO using the given SchemaI as a String and returns an AnnotatedValue which allows to get more info in the case that errors occurred during the call.
static AnnotatedValue	getAnnotatedValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String[] attPath) Tries to get the value for given the attribute path for the given BO using the given SchemaI as a String and returns an AnnotatedValue which allows to get more info in the case that errors occurred during the call.
static AttributeI	getAttribute(SchemaI schema, java.lang.Object bo, java.lang.String attPath) Retrieves the attribute with the given attribute path.
static AttributeI	getAttribute(SchemaI schema, java.lang.Object bo, java.lang.String attPath, boolean noThrow) Retrieves the attribute with the given attribute path.
static BOI	getBOForLastPathElement(SchemaI schema, BOI rootBO, java.lang.String path) Returns the BO for which the final attribute is called, i.e. the second to last attribute.
static EntityI	getEntityForObject(SchemaI schema, java.lang.Object bo) Returns the entity from a given schema for a given bo
static java.util.List<java.lang.String>	getPackageList(SchemaI schema)
static java.util.Map	getRelationObjects(SchemaI schema, java.lang.Object bo, java.lang.String attPath) Returns the relation objects from a attribute specified by the attributepath
static AttributeI	getSingleAttribute(EntityI entity, java.lang.String attributeName) Returns an attribute from a given entity by attribute name
static java.util.Map	getSingleAttributeRelationObjects(EntityI entity, java.lang.Object bo, java.lang.String attributeName) Returns a map with the relations for a single attribute of a bo by the given schema
static java.util.Map	getSingleAttributeRelationObjects(SchemaI schema, java.lang.Object bo, java.lang.String attributeName) Returns a map with the relations for a single attribute of a bo by the given schema
static java.lang.Object	getSingleAttributeValue(EntityI entity, java.lang.Object bo, java.lang.String attributeName) Retrieves the value of an attribute from a given entity and business object by the specified attribute name.
static java.lang.Object	getSingleAttributeValue(EntityI entity, java.lang.Object bo, java.lang.String attributeName, boolean assumeOnlySingleRelations) Retrieves the value of an attribute from a given entity and business object by the specified attribute name.
static java.lang.Object	getSingleAttributeValue(SchemaI schema, java.lang.Object bo, java.lang.String attributeName) Retrieves the value of an attribute by its name from a given schema and business object.
static java.lang.Object	getSingleAttributeValue(SchemaI schema, java.lang.Object bo, java.lang.String attributeName, boolean assumeOnlySingleRelations) Retrieves the value of an attribute from a given schema and business object by the attribute name.
static java.lang.String	getSingleAttributeValueAsString(EntityI entity, java.lang.Object bo, java.lang.String attributeName) Returns the value of an attribute as String from a given entity and bo by the given attribute name, if the attribute is transient it will be returned from the transient properties
static java.lang.String	getSingleAttributeValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attributeName) Returns the value of an attribute as String from a given schema and bo by the given attribute name
static java.lang.Object	getValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath) Returns the value of an attribute specified by the attribute path.
static java.lang.Object	getValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath, boolean nullIfNullOnPath) Returns the value of an attribute specified by the attribute path.
static java.lang.Object	getValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath, boolean nullIfNullOnPath, boolean nullIfAttrMissingOnPath) Returns the value of an attribute specified by the attribute path.
static java.lang.Object	getValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath, boolean nullIfNullOnPath, boolean nullIfAttrMissingOnPath, boolean assumeOnlySingleRelations) Returns the value of an attribute specified by the attribute path.
static java.lang.String	getValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attPath) Returns the value of an attribute specified by the attribute path as a String.
static java.lang.String	getValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attPath, boolean nullIfNullOnPath) Returns the value of an attribute specified by the attribute path as a String.
static boolean	hasRelationObject(SchemaI schema, java.lang.Object bo, java.lang.String attPath, java.lang.Object hasMe) Checks if the attribute of a given bo, specified by the attributepath, contains the given relation objects
static boolean	hasSingleAttributeRelationObject(EntityI entity, java.lang.Object bo, java.lang.String attPath, java.lang.Object value) Checks if the given relational object is set on the given attribute of the given bo
static boolean	hasSingleAttributeRelationObject(SchemaI schema, java.lang.Object bo, java.lang.String attPath, java.lang.Object value) Checks if the given relational object is set on the given attribute of the given bo
static boolean	hasValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath) Checks if the attribute specified by the given path has a value set in the provided business object (BO).
static void	info(electric.xml.Attribute att, java.lang.String msg) Convenience method for logging with attribute prefix (log info messages)
static void	info(electric.xml.Attribute att, java.lang.String msg, java.lang.Throwable cause) Convenience method for logging with attribute prefix (log info messages)
static void	info(electric.xml.Element el, java.lang.String msg) Convenience method for logging with element prefix (log info messages)
static void	info(electric.xml.Element el, java.lang.String msg, java.lang.Throwable cause) Convenience method for logging with element prefix (log info messages)
static boolean	isAnyBOOnPathDeleted(SchemaI schema, BOI bo, java.lang.String attPath) Checks if the given BO or any BO along the specified attribute path is deleted.
static boolean	isTransientAttribute(java.lang.String attrName) Checks if a given attributename is a transient attribute by checking if the first char is an underscore
static void	removeRelationObject(SchemaI schema, java.lang.Object bo, java.lang.String attPath, java.lang.Object removeMe) Removes the given relations from the attribute of a given bo specified by the attributepath
static void	removeSingleAttributeRelationObject(EntityI entity, java.lang.Object bo, java.lang.String attributeName, java.lang.Object value) Removes the given relation object from the given attribute from the given bo
static void	removeSingleAttributeRelationObject(SchemaI schema, java.lang.Object bo, java.lang.String attributeName, java.lang.Object value) Removes the given relation object from the given attribute from the given bo
static void	setSingleAttributeValue(EntityI entity, java.lang.Object bo, java.lang.String attributeName, java.lang.Object value) Sets the value for the attribute with the given attributename in the given bo by a given entity
static void	setSingleAttributeValue(SchemaI schema, java.lang.Object bo, java.lang.String attributeName, java.lang.Object value) Sets the value for the attribute with the given attributename in the given bo by a given schema
static void	setSingleAttributeValueAsString(EntityI entity, java.lang.Object bo, java.lang.String attributeName, java.lang.String value) Sets the provided String value as the value for the specified attribute on the given business object associated with the provided entity.
static void	setSingleAttributeValueAsString(EntityI entity, java.lang.Object bo, java.lang.String attributeName, java.lang.String value, boolean checkConstraints) Sets the provided String value as the value for the specified attribute on the given business object associated with the provided entity.
static void	setSingleAttributeValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attributeName, java.lang.String value) Sets the provided String value as the value for the specified attribute on the given business object within the context of the provided schema.
static void	setSingleAttributeValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attributeName, java.lang.String value, boolean checkConstraints) Sets the provided String value as the value for the specified attribute on the given business object within the context of the provided schema.
static void	setValue(SchemaI schema, java.lang.Object bo, java.lang.String attPath, java.lang.Object value) Sets the given value on a given attribute by path on the given bo for the given schema
static void	setValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attPath, java.lang.String value) Sets the given value as String on a given attribute by path on the given bo for the given schema.
static void	setValueAsString(SchemaI schema, java.lang.Object bo, java.lang.String attPath, java.lang.String value, boolean checkConstraints) Sets the given value as String on a given attribute by path on the given bo for the given schema
static java.lang.String[]	splitAtDelim(java.lang.String s, char delim)
static java.lang.String[]	splitAtDot(java.lang.String s) Returns a given String split into a String-Array by using the dots in the given String as delimiter.
static void	updateRelation(EntityI entity, java.lang.Object bo, java.lang.String attPath, java.lang.Object[] values) Updates the relations on the given attribute on the given bo
static void	warn(electric.xml.Attribute att, java.lang.String msg) Convenience method for logging with attribute prefix (log warn messages)
static void	warn(electric.xml.Attribute att, java.lang.String msg, java.lang.Throwable cause) Convenience method for logging with attribute prefix (log warn messages)
static void	warn(electric.xml.Element el, java.lang.String msg) Convenience method for logging with element prefix (log debug messages)
static void	warn(electric.xml.Element el, java.lang.String msg, java.lang.Throwable cause) Convenience method for logging with element prefix (log debug messages)

Methods inherited from class java.lang.Object

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

Method Detail

isTransientAttribute

public static boolean isTransientAttribute(java.lang.String attrName)

Checks if a given attributename is a transient attribute by checking if the first char is an underscore

Parameters:

attrName - the attribute to check

Returns:

true if the given attribute name starts with underscore

checkSyntacticallyValidAttPath

public static void checkSyntacticallyValidAttPath(java.lang.String attrPath)
                                           throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

splitAtDot

public static java.lang.String[] splitAtDot(java.lang.String s)

Returns a given String split into a String-Array by using the dots in the given String as delimiter. Own implementation because this method is called very often and String#split() is rather slow and costly. [FIXME: Sollte dies nicht eher in texttools stehen? Da gibts auch schon sowas wie splitBydelimeter]

Parameters:

s - the String to split

Returns:

the given String as String-Array splitted at the dots positions

splitAtDelim

public static java.lang.String[] splitAtDelim(java.lang.String s,
                                              char delim)

getPackageList

public static java.util.List<java.lang.String> getPackageList(SchemaI schema)

getAttribute

public static AttributeI getAttribute(SchemaI schema,
                                      java.lang.Object bo,
                                      java.lang.String attPath)

Retrieves the attribute with the given attribute path. This method uses the provided schema interface to find the attribute within the context of the given business object (bo). The attribute path can include relations, and if so, it will be split into a String array to locate the correct business object for attribute retrieval.

Parameters:

schema - The schema interface to search for the attribute.

bo - The business object for which to find the attribute within the schema.

attPath - The attribute path to locate.

Returns:

The attribute corresponding to the given path within the provided schema and business object, or null if none could be found.

getAttribute

public static AttributeI getAttribute(SchemaI schema,
                                      java.lang.Object bo,
                                      java.lang.String attPath,
                                      boolean noThrow)

Retrieves the attribute with the given attribute path. This method uses the provided schema interface to find the attribute within the context of the given business object (bo). The attribute path can include relations, and if so, it will be split into a String array to locate the correct business object for attribute retrieval.

Parameters:

schema - The schema interface to search for the attribute.

bo - The business object for which to find the attribute within the schema.

attPath - The attribute path to locate.

noThrow - If true, no exceptions will be thrown. If an attribute or entity cannot be found, the method returns null. If false, exceptions may be thrown.

Returns:

The attribute corresponding to the given path within the provided schema and business object, or null if none could be found (if noThrow is set to true).

Throws:

NullHasNoTypeException - If there is no entity for the business object in the given schema while looking for it in the relation chain and noThrow is set to false.

AttributeResolveException - If the right entity for the business object or the attribute in the entity could not be found and noThrow is set to false.

getAllRelations

public static java.util.List getAllRelations(EntityI entity)

Returns a List of all attributes of the given entity which are relations, including the attributes from entity bases

Parameters:

entity - the entity to get the relational attribues from

Returns:

a List of all relational attributes from the given entity including the attributes from entity bases

getEntityForObject

public static EntityI getEntityForObject(SchemaI schema,
                                         java.lang.Object bo)

Returns the entity from a given schema for a given bo

Parameters:

schema - the schema to get entity from

bo -

Returns:

the entity from the given schema for the given bo

Throws:

NullHasNoTypeException - if the given bo was null

EntityResolveException - if the entity couldnt be resolved

getSingleAttribute

public static AttributeI getSingleAttribute(EntityI entity,
                                            java.lang.String attributeName)

Returns an attribute from a given entity by attribute name

Parameters:

entity - the entity to get attribute from

attributeName - the attribute name

Returns:

the attribute from the given entity

Throws:

AttributeResolveException - if the given att was null or the attribute couldn't be resolved from entity

getSingleAttributeValue

public static java.lang.Object getSingleAttributeValue(SchemaI schema,
                                                       java.lang.Object bo,
                                                       java.lang.String attributeName)

Retrieves the value of an attribute by its name from a given schema and business object. If the attribute is transient, it will be obtained from the transient properties.

Parameters:

schema - The schema from which to retrieve the entity.

bo - The business object for which to obtain the entity from the schema.

attributeName - The name of the attribute for which to retrieve the value.

Returns:

The value of the specified attribute as an Object.

Throws:

AttributeResolveException - If the given attribute is null or if no attribute of that name could be found in the given schema for the given business object.

getSingleAttributeValue

public static java.lang.Object getSingleAttributeValue(SchemaI schema,
                                                       java.lang.Object bo,
                                                       java.lang.String attributeName,
                                                       boolean assumeOnlySingleRelations)

Retrieves the value of an attribute from a given schema and business object by the attribute name. If the attribute is transient, it will be obtained from the transient properties.

Parameters:

schema - The schema to get the entity from.

bo - The business object for which to obtain the entity from the schema.

attributeName - The name of the attribute for which to retrieve the value.

assumeOnlySingleRelations - If true, assumes that all 1-n relations encountered are used as 1-1 relations. If they have at most one entry, that entry is returned as the value of the relation. If they have more than one entry, the method fails.

Returns:

The attribute value as an Object.

Throws:

AttributeResolveException - If the given attribute is null or if no attribute of that name could be found in the given schema for the given business object.

getSingleAttributeValue

public static java.lang.Object getSingleAttributeValue(EntityI entity,
                                                       java.lang.Object bo,
                                                       java.lang.String attributeName)

Retrieves the value of an attribute from a given entity and business object by the specified attribute name. If the attribute is transient, it will be obtained from the transient properties.

Parameters:

entity - The entity from which to retrieve the attribute for the business object.

bo - The business object for which to obtain the attribute value.

attributeName - The name of the attribute for which to retrieve the value.

Returns:

The attribute value as an Object.

Throws:

AttributeResolveException - If the given attribute is null or the specified entity does not have an attribute with that name.

getSingleAttributeValue

public static java.lang.Object getSingleAttributeValue(EntityI entity,
                                                       java.lang.Object bo,
                                                       java.lang.String attributeName,
                                                       boolean assumeOnlySingleRelations)

Retrieves the value of an attribute from a given entity and business object by the specified attribute name. If the attribute is transient, it will be obtained from the transient properties.

Parameters:

entity - The entity from which to retrieve the attribute for the business object.

bo - The business object for which to obtain the attribute value.

attributeName - The name of the attribute for which to retrieve the value.

assumeOnlySingleRelations - If true, assumes that all 1-n relations encountered are actually used as 1-1 relations. If they have at most one entry, that entry is returned as the value of the relation. If they have more than one entry, the method fails.

Returns:

The attribute value as an Object.

Throws:

AttributeResolveException - If the given attribute is null or the specified entity does not have an attribute with that name.

getSingleAttributeValueAsString

public static java.lang.String getSingleAttributeValueAsString(SchemaI schema,
                                                               java.lang.Object bo,
                                                               java.lang.String attributeName)

Returns the value of an attribute as String from a given schema and bo by the given attribute name

Parameters:

schema - the schema to get entity from

bo - the bo to get entity from schema for

attributeName - the attribute name to get value for

Returns:

the attribue value as String

getSingleAttributeValueAsString

public static java.lang.String getSingleAttributeValueAsString(EntityI entity,
                                                               java.lang.Object bo,
                                                               java.lang.String attributeName)

Returns the value of an attribute as String from a given entity and bo by the given attribute name, if the attribute is transient it will be returned from the transient properties

Parameters:

entity - the entity to get attribute from bo

bo - the bo to get the value from

attributeName - the attribute name to get value for

Returns:

the attribue value as String

Throws:

AttributeResolveException - if the attribute couldn be resolved

setSingleAttributeValue

public static void setSingleAttributeValue(SchemaI schema,
                                           java.lang.Object bo,
                                           java.lang.String attributeName,
                                           java.lang.Object value)

Sets the value for the attribute with the given attributename in the given bo by a given schema

Parameters:

schema - the schema to get Entity for the bo

bo - the bo to set attributevalue in

attributeName - the name of the attribute to set the value for

value - the value to set for the attribute

setSingleAttributeValue

public static void setSingleAttributeValue(EntityI entity,
                                           java.lang.Object bo,
                                           java.lang.String attributeName,
                                           java.lang.Object value)

Sets the value for the attribute with the given attributename in the given bo by a given entity

Parameters:

entity - the entity to get the attribute to set for

bo - the bo to set attributevalue in

attributeName - the name of the attribute to set the value for

value - the value to set for the attribute

setSingleAttributeValueAsString

public static void setSingleAttributeValueAsString(SchemaI schema,
                                                   java.lang.Object bo,
                                                   java.lang.String attributeName,
                                                   java.lang.String value)

Sets the provided String value as the value for the specified attribute on the given business object within the context of the provided schema. Constraints will be checked before setting the value.

Parameters:

schema - The schema from which to obtain the entity for the business object.

bo - The business object on which to set the attribute value.

attributeName - The name of the attribute for which to set the value.

value - The value to set as a String.

setSingleAttributeValueAsString

public static void setSingleAttributeValueAsString(SchemaI schema,
                                                   java.lang.Object bo,
                                                   java.lang.String attributeName,
                                                   java.lang.String value,
                                                   boolean checkConstraints)

Sets the provided String value as the value for the specified attribute on the given business object within the context of the provided schema.

Parameters:

schema - The schema from which to obtain the entity for the business object.

bo - The business object on which to set the attribute value.

attributeName - The name of the attribute for which to set the value.

value - The value to set as a String.

checkConstraints - If true, constraints will be checked before setting the value.

setSingleAttributeValueAsString

public static void setSingleAttributeValueAsString(EntityI entity,
                                                   java.lang.Object bo,
                                                   java.lang.String attributeName,
                                                   java.lang.String value)

Sets the provided String value as the value for the specified attribute on the given business object associated with the provided entity. Constraints will be checked before setting the value.

Parameters:

entity - The entity associated with the business object.

bo - The business object on which to set the attribute value.

attributeName - The name of the attribute for which to set the value.

value - The value to set as a String.

Throws:

AttributeResolveException - If the given attribute is null or the entity does not have an attribute with that name.

setSingleAttributeValueAsString

public static void setSingleAttributeValueAsString(EntityI entity,
                                                   java.lang.Object bo,
                                                   java.lang.String attributeName,
                                                   java.lang.String value,
                                                   boolean checkConstraints)

Sets the provided String value as the value for the specified attribute on the given business object associated with the provided entity.

Parameters:

entity - The entity associated with the business object.

bo - The business object on which to set the attribute value.

attributeName - The name of the attribute for which to set the value.

value - The value to set as a String.

checkConstraints - If true, constraints will be checked before setting the value.

Throws:

AttributeResolveException - If the given attribute is null or the entity does not have an attribute with that name.

getSingleAttributeRelationObjects

public static java.util.Map getSingleAttributeRelationObjects(SchemaI schema,
                                                              java.lang.Object bo,
                                                              java.lang.String attributeName)

Returns a map with the relations for a single attribute of a bo by the given schema

Parameters:

schema - the schema to get an entity for the bo

bo - the bo to get relations for the attribute

attributeName - the attribute to get relations for

Returns:

the realtions map for the attribute

getSingleAttributeRelationObjects

public static java.util.Map getSingleAttributeRelationObjects(EntityI entity,
                                                              java.lang.Object bo,
                                                              java.lang.String attributeName)

Returns a map with the relations for a single attribute of a bo by the given schema

Parameters:

entity - the entity to get attribute from for the bo

bo - the bo to get relations for the attribute

attributeName - the attribute to get relations for

Returns:

the realtions map for the attribute

Throws:

AttributeResolveException

addSingleAttributeRelationObject

public static void addSingleAttributeRelationObject(SchemaI schema,
                                                    java.lang.Object bo,
                                                    java.lang.String attributeName,
                                                    java.lang.Object value)

Adds the given value as relational object to the given attribute of the given bo

Parameters:

schema - the schema to get entity for the bo

bo - the bo to add the relational object to the attribute

attributeName - the name of the attribute to add the relational object on

value - the relational object to add to the attribute on the bo

addSingleAttributeRelationObject

public static void addSingleAttributeRelationObject(EntityI entity,
                                                    java.lang.Object bo,
                                                    java.lang.String attributeName,
                                                    java.lang.Object value)

Adds the given value as relational object to the given attribute of the given bo

Parameters:

entity - the entity to get attribute for from the bo

bo - the bo to add the relational object to the attribute

attributeName - the name of the attribute to add the relational object on

value - the relational object to add to the attribute on the bo

Throws:

AttributeResolveException

removeSingleAttributeRelationObject

public static void removeSingleAttributeRelationObject(SchemaI schema,
                                                       java.lang.Object bo,
                                                       java.lang.String attributeName,
                                                       java.lang.Object value)

Removes the given relation object from the given attribute from the given bo

Parameters:

schema - the schema to get entity for the bo

bo - the bo to remove the relational object from the attribute

attributeName - the name of the attribute to remove the relational object from

value - the relational object to remove

removeSingleAttributeRelationObject

public static void removeSingleAttributeRelationObject(EntityI entity,
                                                       java.lang.Object bo,
                                                       java.lang.String attributeName,
                                                       java.lang.Object value)

Removes the given relation object from the given attribute from the given bo

Parameters:

entity - the entity to get attribute for from the bo

bo - the bo to remove the relational object from the attribute

attributeName - the name of the attribute to remove the relational object from

value - the relational object to remove

Throws:

AttributeResolveException

hasSingleAttributeRelationObject

public static boolean hasSingleAttributeRelationObject(SchemaI schema,
                                                       java.lang.Object bo,
                                                       java.lang.String attPath,
                                                       java.lang.Object value)

Checks if the given relational object is set on the given attribute of the given bo

Parameters:

schema - the schema to get entity for the bo

bo - the bo to check the relational object on the attribute

attPath - the name of the attribute to check the relational object on

value - the relational object to check

hasSingleAttributeRelationObject

public static boolean hasSingleAttributeRelationObject(EntityI entity,
                                                       java.lang.Object bo,
                                                       java.lang.String attPath,
                                                       java.lang.Object value)

Checks if the given relational object is set on the given attribute of the given bo

Parameters:

entity - the entity to get attribute for from the bo

bo - the bo to check the relational object on the attribute

attPath - the name of the attribute to check the relational object on

value - the relational object to check

Throws:

AttributeResolveException

updateRelation

public static void updateRelation(EntityI entity,
                                  java.lang.Object bo,
                                  java.lang.String attPath,
                                  java.lang.Object[] values)

Updates the relations on the given attribute on the given bo

Parameters:

entity - the entity to get attribute for from the bo

bo - the bo to update the relations on the attribute

attPath - the name of the attribute to update the relations

values - the relations to update

getValue

public static java.lang.Object getValue(SchemaI schema,
                                        java.lang.Object bo,
                                        java.lang.String attPath)

Returns the value of an attribute specified by the attribute path.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to retrieve the attribute value from.

attPath - The attribute path specifying where to find the attribute.

Returns:

The value of the specified attribute.

Throws:

AttributeResolveException - If the attribute could not be resolved.

getValue

public static java.lang.Object getValue(SchemaI schema,
                                        java.lang.Object bo,
                                        java.lang.String attPath,
                                        boolean nullIfNullOnPath)

Returns the value of an attribute specified by the attribute path.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to retrieve the attribute value from.

attPath - The attribute path specifying where to find the attribute.

nullIfNullOnPath - If true, null will be returned if the first attribute on the path is null.

Returns:

The value of the specified attribute.

Throws:

AttributeResolveException - If the attribute could not be resolved.

getValue

public static java.lang.Object getValue(SchemaI schema,
                                        java.lang.Object bo,
                                        java.lang.String attPath,
                                        boolean nullIfNullOnPath,
                                        boolean nullIfAttrMissingOnPath)

Returns the value of an attribute specified by the attribute path.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to retrieve the attribute value from.

attPath - The attribute path specifying where to find the attribute.

nullIfNullOnPath - If true, null will be returned if the first attribute on the path is null.

nullIfAttrMissingOnPath - If true, null will be returned instead of throwing an AttributeResolveException if the attribute could not be resolved on the path.

Returns:

The value of the specified attribute.

Throws:

AttributeResolveException - If the attribute could not be resolved and nullIfAttrMissingOnPath was passed as false.

getValue

public static java.lang.Object getValue(SchemaI schema,
                                        java.lang.Object bo,
                                        java.lang.String attPath,
                                        boolean nullIfNullOnPath,
                                        boolean nullIfAttrMissingOnPath,
                                        boolean assumeOnlySingleRelations)

Returns the value of an attribute specified by the attribute path.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to retrieve the attribute value from.

attPath - The attribute path specifying where to find the attribute.

nullIfNullOnPath - If true, null will be returned if the first attribute on the path is null.

nullIfAttrMissingOnPath - If true, null will be returned instead of throwing an AttributeResolveException if the attribute could not be resolved on the path.

assumeOnlySingleRelations - If true, assume that all 1-n relations encountered are actually used as 1-1 relations. If they have at most one entry, use that as the value of the relation; if they have more than one, fail.

Returns:

The value of the specified attribute.

Throws:

AttributeResolveException - If the attribute could not be resolved and nullIfAttrMissingOnPath was passed as false.

collectValues

public static java.util.Collection collectValues(SchemaI schema,
                                                 BOI bo,
                                                 java.lang.String attPath)

Collects all values for the last attribute in the given attribute path, resolving the many-relations in the path. For example, suppose Entity #1 has a many relation to Entity #2, and Entity #2 has a many relation to Entity #3. Calling collectValues() with "bo" being an instance of Entity #1 will: 1. Get all entries of the relation to Entity #2. 2. For each of these entries, get all values of the relation to Entity #3. 3. Return all these Entity #3 values as one collection.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to start collecting values from.

attPath - The attribute path specifying where to find the values.

Returns:

A Collection with all collected values, or null if attPath is empty

collectValues

public static java.util.Collection collectValues(SchemaI schema,
                                                 BOI bo,
                                                 java.lang.String attPath,
                                                 boolean nullIfNullOnPath)

Collects all values for the last attribute in the given attribute path, resolving the many-relations in the path. For example, suppose Entity #1 has a many relation to Entity #2, and Entity #2 has a many relation to Entity #3. Calling collectValues() with "bo" being an instance of Entity #1 will: 1. Get all entries of the relation to Entity #2. 2. For each of these entries, get all values of the relation to Entity #3. 3. Return all these Entity #3 values as one collection.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to start collecting values from.

attPath - The attribute path specifying where to find the values.

nullIfNullOnPath - If true, null will be returned if any value on the path is null.

Returns:

A Collection with all collected values, or null if: - attPath is empty - A value on the path is null (and nullIfNullOnPath is true).

collectValues

public static java.util.Collection collectValues(SchemaI schema,
                                                 BOI bo,
                                                 java.lang.String attPath,
                                                 boolean nullIfNullOnPath,
                                                 boolean nullIfAttrMissingOnPath)

Collects all values for the last attribute in the given attribute path, resolving the many-relations in the path. For example, suppose Entity #1 has a many relation to Entity #2, and Entity #2 has a many relation to Entity #3. Calling collectValues() with "bo" being an instance of Entity #1 will: 1. Get all entries of the relation to Entity #2. 2. For each of these entries, get all values of the relation to Entity #3. 3. Return all these Entity #3 values as one collection.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to start collecting values from.

attPath - The attribute path specifying where to find the values.

nullIfNullOnPath - If true, null will be returned if any value on the path is null.

nullIfAttrMissingOnPath - If true, null will be returned if any attribute on the path could not be found.

Returns:

A Collection with all collected values, or null if: - attPath is empty - A value on the path is null (and nullIfNullOnPath is true) - Some attribute on the path could not be found (and nullIfAttrMissingOnPath is true).

getValueAsString

public static java.lang.String getValueAsString(SchemaI schema,
                                                java.lang.Object bo,
                                                java.lang.String attPath)

Returns the value of an attribute specified by the attribute path as a String.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to get the attribute value from.

attPath - The attribute path specifying where to find the attribute.

Returns:

The attribute value as a String.

getValueAsString

public static java.lang.String getValueAsString(SchemaI schema,
                                                java.lang.Object bo,
                                                java.lang.String attPath,
                                                boolean nullIfNullOnPath)

Returns the value of an attribute specified by the attribute path as a String.

Parameters:

schema - The schema to get the entity for the business object.

bo - The business object to get the attribute value from.

attPath - The attribute path specifying where to find the attribute.

nullIfNullOnPath - If true, null will be returned if no business object was found for the given attribute path.

Returns:

The attribute value as a String, or null if no matching attribute path was found and nullIfNullOnPath is true.

getAnnotatedValue

public static AnnotatedValue getAnnotatedValue(SchemaI schema,
                                               java.lang.Object bo,
                                               java.lang.String attPath)

Tries to retrieve the value for the given attribute (chain) from the specified BO using the provided SchemaI. This method returns an AnnotatedValue, allowing you to obtain more information in case of errors during retrieval.

Parameters:

schema - The SchemaI to be used for retrieval.

bo - The BO from which the value should be retrieved.

attPath - The attribute or attribute chain from which the value should be retrieved.

Returns:

An AnnotatedValue containing either the retrieved value or representing an error that occurred during retrieval.

getAnnotatedValue

public static AnnotatedValue getAnnotatedValue(SchemaI schema,
                                               java.lang.Object bo,
                                               java.lang.String[] attPath)

Tries to retrieve the value for the given attribute path from the specified BO using the provided SchemaI. This method returns an AnnotatedValue, allowing you to obtain more information in case of errors during retrieval.

Parameters:

schema - The SchemaI to be used for retrieval.

bo - The BO from which the value should be retrieved.

attPath - A String array with attribute names representing the path via which the value should be retrieved.

Returns:

An AnnotatedValue containing either the retrieved value or representing an error that occurred during retrieval.

getAnnotatedValue

public static AnnotatedValue getAnnotatedValue(SchemaI schema,
                                               java.lang.Object bo,
                                               java.lang.String attPath,
                                               boolean assumeOnlySingleRelations)

Tries to retrieve the value for the given attribute (chain) from the specified BO using the provided SchemaI. This method returns an AnnotatedValue, allowing you to obtain more information in case of errors during retrieval.

Parameters:

schema - The SchemaI to be used for retrieval.

bo - The BO from which the value should be retrieved.

attPath - The attribute or attribute chain from which the value should be retrieved.

assumeOnlySingleRelations - If true, assume that all 1-n relations encountered are actually used as 1-1 relations (technically not possible in MyTISM but in some cases useful). If they have at most one entry, use that as the value of the relation; if they have more than one, fail.

Returns:

An AnnotatedValue containing either the retrieved value or representing an error that occurred during retrieval.

getAnnotatedValue

public static AnnotatedValue getAnnotatedValue(SchemaI schema,
                                               java.lang.Object bo,
                                               java.lang.String[] attPath,
                                               boolean assumeOnlySingleRelations)

Tries to retrieve the value for the given attribute path from the specified BO using the provided SchemaI. This method returns an AnnotatedValue, allowing you to obtain more information in case of errors during retrieval.

Parameters:

schema - The SchemaI to be used for retrieval.

bo - The BO from which the value should be retrieved.

attPath - A String array with attribute names representing the path via which the value should be retrieved.

assumeOnlySingleRelations - If true, assume that all 1-n relations encountered are actually used as 1-1 relations (technically not possible in MyTISM but in some cases useful). If they have at most one entry, use that as the value of the relation; if they have more than one, fail.

Returns:

An AnnotatedValue containing either the retrieved value or representing an error that occurred during retrieval.

getAnnotatedValueAsString

public static AnnotatedValue getAnnotatedValueAsString(SchemaI schema,
                                                       java.lang.Object bo,
                                                       java.lang.String attPath)

Tries to get the value for given the attribute (chain) for the given BO using the given SchemaI as a String and returns an AnnotatedValue which allows to get more info in the case that errors occurred during the call.

Parameters:

schema - the SchemaI that should be used

bo - the BO from which the value should be retrieved

attPath - the attribute or attribute chaing from which the value should be retrieved

Returns:

an AnnotatedValue that either holds the value as a String or represents an error that occurred during the retrieval

getAnnotatedValueAsString

public static AnnotatedValue getAnnotatedValueAsString(SchemaI schema,
                                                       java.lang.Object bo,
                                                       java.lang.String[] attPath)

Tries to get the value for given the attribute path for the given BO using the given SchemaI as a String and returns an AnnotatedValue which allows to get more info in the case that errors occurred during the call.

Parameters:

schema - the SchemaI that should be used

bo - the BO from which the value should be retrieved

attPath - A String array with attribute names representing the path via which the value should be retrieved

Returns:

an AnnotatedValue that either holds the value as a String or represents an error that occurred during the retrieval

hasValue

public static boolean hasValue(SchemaI schema,
                               java.lang.Object bo,
                               java.lang.String attPath)

Checks if the attribute specified by the given path has a value set in the provided business object (BO).

This method traverses the attribute path within the specified BO and determines whether the target attribute has a value assigned. It handles different attribute types, including maps, and considers empty maps as having no value.

Parameters:

schema - The schema used to resolve the attribute.

bo - The business object to use as start for reaching the attribute via the given path.

attPath - The path to the attribute.

Returns:

true if the attribute has a value set, false otherwise.

isAnyBOOnPathDeleted

public static boolean isAnyBOOnPathDeleted(SchemaI schema,
                                           BOI bo,
                                           java.lang.String attPath)

Checks if the given BO or any BO along the specified attribute path is deleted.

This method traverses the attribute path from the given BO and checks if any BO along the path, including the starting BO, is marked as deleted. It handles cases where the path contains relations to other BOs and returns false if the path is empty or if any attribute along the path does not exist or has a non-BO value (i.e. a many-relation).

Parameters:

schema - The schema used to resolve the BO's entity.

bo - The starting business object.

attPath - The attribute path to traverse.

Returns:

true if the starting BO or any BO along the path is deleted, false otherwise.

setValue

public static void setValue(SchemaI schema,
                            java.lang.Object bo,
                            java.lang.String attPath,
                            java.lang.Object value)

Sets the given value on a given attribute by path on the given bo for the given schema

Parameters:

schema - the schema to get entity for the bo

bo - the bo to get the attribute by the path

attPath - the attributepath where to find the attribute

value - the value to set on the attribute

setValueAsString

public static void setValueAsString(SchemaI schema,
                                    java.lang.Object bo,
                                    java.lang.String attPath,
                                    java.lang.String value)

Sets the given value as String on a given attribute by path on the given bo for the given schema. Checks for constraints before setting the value.

Parameters:

schema - the schema to get entity for the bo

bo - the bo to get the attribute by the path

attPath - the attributepath where to find the attribute

value - the value to set on the attribute

setValueAsString

public static void setValueAsString(SchemaI schema,
                                    java.lang.Object bo,
                                    java.lang.String attPath,
                                    java.lang.String value,
                                    boolean checkConstraints)

Sets the given value as String on a given attribute by path on the given bo for the given schema

Parameters:

schema - the schema to get entity for the bo

bo - the bo to get the attribute by the path

attPath - the attributepath where to find the attribute

value - the value to set on the attribute

checkConstraints - if true we shall check for constraints before setting the value

getRelationObjects

public static java.util.Map getRelationObjects(SchemaI schema,
                                               java.lang.Object bo,
                                               java.lang.String attPath)

Returns the relation objects from a attribute specified by the attributepath

Parameters:

schema - the schema to get entity for the bo

bo - the bo to get the attribute by the path

attPath - the attributepath where to find the attribute

Returns:

the relation objects from a attribute as a Map

addRelationObject

public static void addRelationObject(SchemaI schema,
                                     java.lang.Object bo,
                                     java.lang.String attPath,
                                     java.lang.Object addMe)

Adds the given relations to the attribute of a given bo specified by the attributepath

Parameters:

schema - the schema to get entity for the bo

bo - the bo to get the attribute by the path

attPath - the attributepath where to find the attribute

addMe - the relation objects to add to the attribute

removeRelationObject

public static void removeRelationObject(SchemaI schema,
                                        java.lang.Object bo,
                                        java.lang.String attPath,
                                        java.lang.Object removeMe)

Removes the given relations from the attribute of a given bo specified by the attributepath

Parameters:

schema - the schema to get entity for the bo

bo - the bo to get the attribute by the path

attPath - the attributepath where to find the attribute

removeMe - the relation objects to remove from the attribute

hasRelationObject

public static boolean hasRelationObject(SchemaI schema,
                                        java.lang.Object bo,
                                        java.lang.String attPath,
                                        java.lang.Object hasMe)

Checks if the attribute of a given bo, specified by the attributepath, contains the given relation objects

Parameters:

schema - the schema to get entity for the bo

bo - the bo to get the attribute by the path

attPath - the attributepath where to find the attribute

hasMe - the relation objects to check on the attribute

Returns:

true if the given attribute contains the given object

debug

public static void debug(java.lang.String msg)

Convenience method for logging (log debug messages)

Parameters:

msg - the message to log

debug

public static void debug(java.lang.String msg,
                         java.lang.Throwable cause)

Convenience method for logging (log debug messages)

Parameters:

msg - the message to log

cause - the cause for the log (mostly from an exception)

warn

public static void warn(electric.xml.Attribute att,
                        java.lang.String msg)

Convenience method for logging with attribute prefix (log warn messages)

Parameters:

att - the attribute to get a messageprefix for

msg - the message to log

warn

public static void warn(electric.xml.Attribute att,
                        java.lang.String msg,
                        java.lang.Throwable cause)

Convenience method for logging with attribute prefix (log warn messages)

Parameters:

att - the attribute to get a messageprefix for

msg - the message to log

cause - the cause for the log (mostly from an exception)

warn

public static void warn(electric.xml.Element el,
                        java.lang.String msg)

Convenience method for logging with element prefix (log debug messages)

Parameters:

el - the element to get a messageprefix for

msg - the message to log

warn

public static void warn(electric.xml.Element el,
                        java.lang.String msg,
                        java.lang.Throwable cause)

Convenience method for logging with element prefix (log debug messages)

Parameters:

el - the element to get a messageprefix for

msg - the message to log

cause - the cause for the log (mostly from an exception)

info

public static void info(electric.xml.Attribute att,
                        java.lang.String msg)

Convenience method for logging with attribute prefix (log info messages)

Parameters:

att - the attribute to get a messageprefix for

msg - the message to log

info

public static void info(electric.xml.Attribute att,
                        java.lang.String msg,
                        java.lang.Throwable cause)

Convenience method for logging with attribute prefix (log info messages)

Parameters:

att - the attribute to get a messageprefix for

msg - the message to log

cause - the cause for the log (mostly from an exception)

info

public static void info(electric.xml.Element el,
                        java.lang.String msg)

Convenience method for logging with element prefix (log info messages)

Parameters:

el - the element to get a messageprefix for

msg - the message to log

info

public static void info(electric.xml.Element el,
                        java.lang.String msg,
                        java.lang.Throwable cause)

Convenience method for logging with element prefix (log info messages)

Parameters:

el - the element to get a messageprefix for

msg - the message to log

cause - the cause for the log (mostly from an exception)

determineProjectBasePackageName

public static java.lang.String determineProjectBasePackageName(SchemaI schema)

This method tries to determine the name of the "base package" of a project from the package/classnames of the EntityIs in the given SchemaI. This information is needed for the feature/licensing framework and import of projects' prebuilt L10nBundles.

determineProjectPackageNames

public static java.lang.String[] determineProjectPackageNames(SchemaI _schema)

Determinates the ProjectPackageNames from a given Schema by iterating the entitylist and adding the entity packages

Parameters:

_schema - the Schema to get ProjectPackageNames for

Returns:

a StringArray with the ProjectPackageNames of the entities in the Schema

entitiesToClasses

public static java.util.Map entitiesToClasses(java.util.Collection entities)

Maps the provided EntityI objects into an IdentityHashMap with EntityI#getClazz() as their values.

getBOForLastPathElement

public static BOI getBOForLastPathElement(SchemaI schema,
                                          BOI rootBO,
                                          java.lang.String path)

Returns the BO for which the final attribute is called, i.e. the second to last attribute.

Parameters:

schema - The schema that is used to check the attributes & values

rootBO - The BO on which the attribute path starts

path - The attribute path to check

getAllPossibleRelationsTo

public static AttributeI[] getAllPossibleRelationsTo(EntityI ent)

Returns all persistent AttributeI-s possibly referring to a given EntityI (or one of it's super classes), even if they're marked as ignoreBackRelation.

Parameters:

ent - The EntityI to search attributes able to refer to it

Returns:

an array of AttributeI within the schema being able to relate to the given entity.