com.technia.tvc.core.db

Class RelationshipUtils

java.lang.Object

com.technia.tvc.core.db.RelationshipUtils

public final class RelationshipUtils
extends java.lang.Object

Contains utility methods that applies to relationships.

Method Summary

Modifier and Type	Method and Description
static void	cloneAttributes(java.lang.String fromRelId, java.lang.String toRelId) Tries to clone the attributes from one relationship to the other.
static void	delete(matrix.db.Relationship rel) Removes this connection in database, i.e disconnects the objects.
static void	delete(java.lang.String relationshipId) Removes this connection in database, i.e disconnects the objects.
static boolean	exists(java.lang.String relId)
static matrix.db.AttributeList	getAttributes(java.lang.String connectionId) Returns the attribute values for a specific connection
static java.lang.String	getFromRelationshipID(java.lang.String fromObjectId, java.lang.String toObjectId, java.lang.String relType) Returns the ID of the from relationship between the specified business objects using business object print
static java.lang.String	getRelationshipID(java.lang.String fromObjectId, java.lang.String toObjectId, java.lang.String relType) Returns the ID of the relationship between the specified business objects.
static java.lang.String	getToRelationshipID(java.lang.String toObjectId, java.lang.String fromObjectId, java.lang.String relType) Returns the ID of the to relationship between the specified business objects using business object print
static boolean	hasAttribute(java.lang.String relationship, java.lang.String attribute) Check whether the relationship has an attribute with the specified name or not.
static boolean	hasRelationship(java.lang.String fromObjectId, java.lang.String toObjectId, java.lang.String relType) Returns true or false, if the provided objects are connected with the specified relationship type.
static boolean	hasRelationship(java.lang.String fromObjectId, java.lang.String toObjectId, java.lang.String relType, boolean useQueryConnection) Returns true or false, if the provided objects are connected with the specified relationship type.
static boolean	modify(java.lang.String relid, java.lang.String expr, java.lang.String newValue) Modify a connection value given by a select expression (e.g., modifying the expression attribute[Weight] will modify the attribute Weight on the relationship).
static void	modifyAttribute(matrix.db.Relationship rel, matrix.db.Attribute attribute) Modifies a relationship attribute.
static void	modifyAttribute(java.lang.String relid, java.lang.String attribute, java.lang.String value) Modifies a relationship attribute.
static void	modifyAttributes(matrix.db.Relationship rel, matrix.db.AttributeList attrs) Modified the attributes.
static void	modifyAttributes(java.lang.String relationshipId, matrix.db.AttributeList attrs) Modified the attributes.
static java.lang.String	modifyFrom(java.lang.String relid, java.lang.String newFromObjectId) Modify which object should be connected on the from side of the relationship.
static java.lang.String	modifyObject(java.lang.String relid, boolean from, java.lang.String newObjectId) Modify which object should be connected on the specified side of the relationship.
static java.lang.String	modifyTo(java.lang.String relid, java.lang.String newToObjectId) Modify which object should be connected on the to side of the relationship.
static void	modifyType(java.lang.String relid, java.lang.String type) Modifies a relationship attribute.
static java.lang.String	replaceObject(java.lang.String relid, java.lang.String sourceObjectId, java.lang.String targetObjectId) Replaces the source object with the target object on the specified relationship
static matrix.db.RelationshipWithSelect	select(matrix.db.Relationship rel, matrix.util.StringList selects) Does a select on a relationship.
static java.lang.String[]	select(java.lang.String[] ids, Statement statement) Selects the statement on all connections.
static matrix.db.RelationshipWithSelectList	select(java.lang.String[] relIds, Statement[] statements) Does a select on a relationship list.
static matrix.db.RelationshipWithSelectList	select(java.lang.String[] relIds, java.lang.String select) Does a select on a relationship list.
static matrix.db.RelationshipWithSelectList	select(java.lang.String[] relIds, matrix.util.StringList selects) Does a select on a relationship list.
static java.lang.String[]	select(java.lang.String id, Statement... statements) Select the specified statements on a particular relationship.
static java.lang.String[]	select(java.lang.String id, java.lang.String... statements) Select the specified statements on a particular relationship.
static java.lang.String	select(java.lang.String relId, java.lang.String statement) Selects the statement from the connection.
static matrix.db.RelationshipWithSelect	select(java.lang.String relId, matrix.util.StringList selects) Does a select on a relationship.
static matrix.util.StringList[]	selectList(java.lang.String rid, Statement[] statements) Select an array of statements on a particular relationship.
static matrix.util.StringList[]	selectList(java.lang.String rid, java.lang.String... statements) Select an array of statements on a particular relationship.
static void	setAttribute(java.lang.String relId, java.lang.String attribute, java.lang.String... values) Modifies a multivalue attribute on relationship.
static void	setAttributes(matrix.db.Relationship relationship, java.util.Collection<matrix.db.Attribute> attributes) Sets attributes on a relationship.
static void	setAttributes(java.lang.String relationshipId, java.util.Collection<matrix.db.Attribute> attributes) Sets attributes on a relationship.
static boolean	typeExists(java.lang.String relationshipType) Checks whether or not the specified relationship type exists in the database.

Methods inherited from class java.lang.Object

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

Method Detail

typeExists

public static boolean typeExists(java.lang.String relationshipType)

Checks whether or not the specified relationship type exists in the database.

hasAttribute

public static boolean hasAttribute(java.lang.String relationship,
                                   java.lang.String attribute)
                            throws TVCException

Check whether the relationship has an attribute with the specified name or not.

Parameters:

relationship - The name of the relationship.

attribute - The name of the attribute.

Returns:

Whether the relationship has an attribute with the specified name or not.

Throws:

TVCException

cloneAttributes

public static void cloneAttributes(java.lang.String fromRelId,
                                   java.lang.String toRelId)
                            throws TVCException

Tries to clone the attributes from one relationship to the other.

Throws:

TVCException

delete

public static void delete(matrix.db.Relationship rel)
                   throws TVCException

Removes this connection in database, i.e disconnects the objects.

Throws:

TVCException

delete

public static void delete(java.lang.String relationshipId)
                   throws TVCException

Removes this connection in database, i.e disconnects the objects.

Throws:

TVCException

modifyAttribute

public static void modifyAttribute(matrix.db.Relationship rel,
                                   matrix.db.Attribute attribute)
                            throws TVCException

Modifies a relationship attribute.

Parameters:

rel - The relationship to modify

attribute - The attribute to modify

Throws:

TVCException - If unable to modify the specified attribute.

modifyAttribute

public static void modifyAttribute(java.lang.String relid,
                                   java.lang.String attribute,
                                   java.lang.String value)
                            throws TVCException

Modifies a relationship attribute.

Parameters:

relid - Relationship id for connection to modify

attribute - The name of the attribute to modify

value - The new value

Throws:

TVCException - If unable to modify the specified attribute.

setAttribute

public static void setAttribute(java.lang.String relId,
                                java.lang.String attribute,
                                java.lang.String... values)
                         throws TVCException

Modifies a multivalue attribute on relationship.

Parameters:

relid - Relationship id for connection to modify

attribute - The name of the attribute to modify

value - The new values to set

Throws:

TVCException - If unable to modify the specified attribute.

modifyAttributes

public static void modifyAttributes(java.lang.String relationshipId,
                                    matrix.db.AttributeList attrs)
                             throws TVCException

Modified the attributes.

Parameters:

relationshipId - The id of the relationship to modify the attributes on.

attrs - The attributes that should be modified.

Throws:

TVCException - If unable to modify the specified attributes.

modifyAttributes

public static void modifyAttributes(matrix.db.Relationship rel,
                                    matrix.db.AttributeList attrs)
                             throws TVCException

Modified the attributes.

Parameters:

rel - The relationship to modify attributes on.

attrs - The attributes that should be modified.

Throws:

TVCException - If unable to modify the specified attributes.

modifyType

public static void modifyType(java.lang.String relid,
                              java.lang.String type)
                       throws TVCException

Modifies a relationship attribute.

Parameters:

relid - Relationship id for connection to modify

type - The name of the new relationship type.

Throws:

TVCException - If unable to modify the specified attribute

replaceObject

public static java.lang.String replaceObject(java.lang.String relid,
                                             java.lang.String sourceObjectId,
                                             java.lang.String targetObjectId)
                                      throws TVCException

Replaces the source object with the target object on the specified relationship

Parameters:

relid - The relationship id

sourceObjectId - The object id of the object to be replaced

targetObjectId - The object id of the object that will be used as replacement

Throws:

TVCException - upon failure

Since:

4.1.0

modifyFrom

public static java.lang.String modifyFrom(java.lang.String relid,
                                          java.lang.String newFromObjectId)
                                   throws TVCException

Modify which object should be connected on the from side of the relationship.

Parameters:

newFromObjectId - The ID of the business object that should be connected on the from side of the relationship.

Throws:

TVCException - If unable to modify.

modifyTo

public static java.lang.String modifyTo(java.lang.String relid,
                                        java.lang.String newToObjectId)
                                 throws TVCException

Modify which object should be connected on the to side of the relationship.

Parameters:

relid - The ID of the relationship.

newToObjectId - The ID of the business object that should be connected on the to side of the relationship.

Throws:

TVCException - If unable to modify.

modifyObject

public static java.lang.String modifyObject(java.lang.String relid,
                                            boolean from,
                                            java.lang.String newObjectId)
                                     throws TVCException

Modify which object should be connected on the specified side of the relationship.

Parameters:

relid - The ID of the relationship.

from - True to modify which object is connected on the from side, false to modify which is connected on the to side.

newObjectId - The ID of the business object that should be connected on the specified side of the relationship.

Throws:

TVCException - If unable to modify.

modify

public static boolean modify(java.lang.String relid,
                             java.lang.String expr,
                             java.lang.String newValue)
                      throws TVCException

Modify a connection value given by a select expression (e.g., modifying the expression attribute[Weight] will modify the attribute Weight on the relationship).

Parameters:

relid - Relationship id for connection to modify.

expr - Select expression specifying which value to modify.

newValue - New value.

Returns:

A boolean value indicating whether the relationship was modified (i.e., if the expression was valid and if the database was updated).

Throws:

TVCException

select

public static java.lang.String[] select(java.lang.String id,
                                        java.lang.String... statements)
                                 throws TVCException

Select the specified statements on a particular relationship.

Parameters:

id - The ID of the relationship.

statements - The select statements.

Returns:

An array containing the results of the select statements.

Throws:

TVCException - If an error occurs when selecting data.

Since:

5.0.0

select

public static java.lang.String[] select(java.lang.String id,
                                        Statement... statements)
                                 throws TVCException

Select the specified statements on a particular relationship.

Parameters:

id - The ID of the relationship.

statements - The select statements.

Returns:

An array containing the results of the select statements.

Throws:

TVCException - If an error occurs when selecting data.

Since:

6.1.8

selectList

public static matrix.util.StringList[] selectList(java.lang.String rid,
                                                  java.lang.String... statements)
                                           throws TVCException

Select an array of statements on a particular relationship.

Parameters:

rid - The ID of the relationship.

statements - An array of select statements.

Returns:

The result is returned as an array of StringList instances.

Throws:

TVCException - If unable to select data from the database.

Since:

6.1.8

selectList

public static matrix.util.StringList[] selectList(java.lang.String rid,
                                                  Statement[] statements)
                                           throws TVCException

Select an array of statements on a particular relationship.

Parameters:

rid - The ID of the relationship.

statements - An array of select statements.

Returns:

The result is returned as an array of StringList instances.

Throws:

TVCException - If unable to select data from the database.

Since:

6.1.8

select

public static java.lang.String select(java.lang.String relId,
                                      java.lang.String statement)
                               throws TVCException

Selects the statement from the connection.

Parameters:

relId - A relationship ID.

statement - A select statement.

Returns:

The result.

Throws:

TVCException - If unable to select.

select

public static matrix.db.RelationshipWithSelect select(matrix.db.Relationship rel,
                                                      matrix.util.StringList selects)
                                               throws TVCException

Does a select on a relationship.

Parameters:

rel - The relationship to select information from.

selects - A list of select statements.

Returns:

A RelationshipWithSelect instance containing the selected information.

Throws:

TVCException - If an error occurs.

select

public static matrix.db.RelationshipWithSelect select(java.lang.String relId,
                                                      matrix.util.StringList selects)
                                               throws TVCException

Does a select on a relationship.

Parameters:

relId - The relationship ID.

selects - A list of select statements.

Returns:

A RelationshipWithSelect instance containing the selected information.

Throws:

TVCException - If an error occurs.

select

public static matrix.db.RelationshipWithSelectList select(java.lang.String[] relIds,
                                                          java.lang.String select)
                                                   throws TVCException

Does a select on a relationship list.

Parameters:

relIds - The relationship IDs.

select - A select statement.

Returns:

A RelationshipWithSelectList instance containing the selected information.

Throws:

TVCException - If an error occurs.

Since:

6.0

select

public static matrix.db.RelationshipWithSelectList select(java.lang.String[] relIds,
                                                          Statement[] statements)
                                                   throws TVCException

Does a select on a relationship list.

Parameters:

relIds - The relationship IDs.

statements - An array of select statements.

Returns:

A RelationshipWithSelectList instance containing the selected information.

Throws:

TVCException - If an error occurs.

Since:

2009.3.1

select

public static matrix.db.RelationshipWithSelectList select(java.lang.String[] relIds,
                                                          matrix.util.StringList selects)
                                                   throws TVCException

Does a select on a relationship list.

Parameters:

relIds - The relationship IDs.

selects - A list of select statements.

Returns:

A RelationshipWithSelectList instance containing the selected information.

Throws:

TVCException - If an error occurs.

Since:

6.0

getFromRelationshipID

public static java.lang.String getFromRelationshipID(java.lang.String fromObjectId,
                                                     java.lang.String toObjectId,
                                                     java.lang.String relType)
                                              throws TVCException

Returns the ID of the from relationship between the specified business objects using business object print

Parameters:

fromObjectId - The ID of the business object on the from side of the relationship.

toObjectId - The ID of the business object on the to side of the relationship.

relType - The type of relationship that the objects have been connected with.

Returns:

The ID of the from relationship between the specified business objects or NULL if no such connection exists.

Throws:

TVCException - If unable to communicate with the database.

getToRelationshipID

public static java.lang.String getToRelationshipID(java.lang.String toObjectId,
                                                   java.lang.String fromObjectId,
                                                   java.lang.String relType)
                                            throws TVCException

Returns the ID of the to relationship between the specified business objects using business object print

Parameters:

toObjectId - The ID of the business object on the to side of the relationship.

fromObjectId - The ID of the business object on the from side of the relationship.

relType - The type of relationship that the objects have been connected with.

Returns:

The ID of the to relationship between the specified business objects or NULL if no such connection exists.

Throws:

TVCException - If unable to communicate with the database.

getRelationshipID

public static java.lang.String getRelationshipID(java.lang.String fromObjectId,
                                                 java.lang.String toObjectId,
                                                 java.lang.String relType)
                                          throws TVCException

Returns the ID of the relationship between the specified business objects. Note that if more than one relationship exist between the specified objects of the specified relationship type this method will only return the ID of the first found.

Parameters:

fromObjectId - The ID of the business object on the from side of the relationship.

toObjectId - The ID of the business object on the to side of the relationship.

relType - The type of relationship that the objects have been connected with.

Returns:

The ID of the relationship between the specified business objects or NULL if no such connection exists.

Throws:

TVCException - If unable to communicate with the database.

hasRelationship

public static boolean hasRelationship(java.lang.String fromObjectId,
                                      java.lang.String toObjectId,
                                      java.lang.String relType,
                                      boolean useQueryConnection)
                               throws TVCException

Returns true or false, if the provided objects are connected with the specified relationship type.

If the parameter useQueryConnection is set to true, we will use the MQL command "query connection" to determine if the objects are connected, otherwise we will use the MQL command print connection bus A to B rel X select id dump IF there is a transaction active. If the latter is not the case, we will perform a standard expand to determine if the objects are connected.

Parameters:

fromObjectId - The from object id

toObjectId - The to object id

relType - The relationship type

useQueryConnection - Uses MQL Query connection if available

Returns:

True or false

Throws:

TVCException - In case something funny happens in Matrix

Since:

6.1.7

hasRelationship

public static boolean hasRelationship(java.lang.String fromObjectId,
                                      java.lang.String toObjectId,
                                      java.lang.String relType)
                               throws TVCException

Returns true or false, if the provided objects are connected with the specified relationship type.

Parameters:

fromObjectId - The from object id

toObjectId - The to object id

relType - The relationship type

Returns:

True or false

Throws:

TVCException

Since:

2011.3.0

getAttributes

public static matrix.db.AttributeList getAttributes(java.lang.String connectionId)
                                             throws TVCException

Returns the attribute values for a specific connection

Parameters:

connectionId - The connection id

Returns:

The attribute list

Throws:

TVCException

select

public static java.lang.String[] select(java.lang.String[] ids,
                                        Statement statement)
                                 throws TVCException

Selects the statement on all connections.

Parameters:

ids - An array of connection IDs.

statement - A select statement.

Returns:

An array of results.

Throws:

TVCException - If unable to select.

Since:

2009.1.0

exists

public static boolean exists(java.lang.String relId)
                      throws TVCException

Throws:

TVCException

setAttributes

public static void setAttributes(java.lang.String relationshipId,
                                 java.util.Collection<matrix.db.Attribute> attributes)
                          throws TVCException

Sets attributes on a relationship.

Parameters:

relationshipId - Relationship id to set attributes on

attributes - Attributes to set

Throws:

TVCException

setAttributes

public static void setAttributes(matrix.db.Relationship relationship,
                                 java.util.Collection<matrix.db.Attribute> attributes)
                          throws TVCException

Sets attributes on a relationship.

Parameters:

relationship - Relationship to set attributes on

attributes - Attributes to set

Throws:

TVCException