com.technia.tvc.core.db

Class DataObjectUtils

java.lang.Object

com.technia.tvc.core.db.DataObjectUtils

public class DataObjectUtils
extends java.lang.Object

Contains utility methods for working with so called dataobjects, which were introduced in Matrix 10.7.

Since:

6.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataObjectUtils.DataObjectInfo Wraps the information about a data object

Method Summary

Modifier and Type	Method and Description
static void	add(java.lang.String dataObject) Adds a new data object for the current user.
static void	add(java.lang.String dataObject, java.lang.String value) Adds a new data object for the current user with the specified value set as the initial value.
static void	add(java.lang.String dataObject, java.lang.String user, java.lang.String value) Adds a new data object for the specified user with the specified value set as the initial value.
static void	delete(java.lang.String dataObject) Deletes a new data object owned by the current user.
static void	delete(java.lang.String dataObject, java.lang.String user) Deletes a new data object owned by the specified user.
static boolean	exists(java.lang.String dataObject) Returns true if the specified dataobject exists for the current user
static boolean	exists(java.lang.String dataObject, java.lang.String user) Returns true if the specified dataobject exists for the specified user
static DataObjectUtils.DataObjectInfo	getDataObjectInfo(java.lang.String name) Returns a DataObjectUtils.DataObjectInfo instance, holding the information about a data object, from the current user.
static DataObjectUtils.DataObjectInfo	getDataObjectInfo(java.lang.String name, java.lang.String user) Returns a DataObjectUtils.DataObjectInfo instance, holding the information about a data object, from the specified user.
static DataObjectUtils.DataObjectInfo[]	getDataObjectInfos() Returns an array of DataObjectUtils.DataObjectInfo instances, holding the information about a data object, from the current user.
static DataObjectUtils.DataObjectInfo[]	getDataObjectInfos(java.lang.String user) Returns an array of DataObjectUtils.DataObjectInfo instances, holding the information about a data object, from the specified user.
static java.lang.String[]	getDataObjectNames() Returns the dataobject names owned by the current user.
static java.lang.String[]	getDataObjectNames(java.lang.String user) Returns the dataobject names owned by the specified user.
static java.util.Iterator<DataObjectUtils.DataObjectInfo>	getDataObjectsOfType(java.lang.String type) Returns an iterator of the data object that has a certain type.
static java.util.Iterator<DataObjectUtils.DataObjectInfo>	getDataObjectsOfType(java.lang.String type, java.lang.String user) Returns an iterator of the data object that has a certain type.
static java.util.Date	getModified(java.lang.String dataObject, java.lang.String user) Returns the modified timestamp for a dataobject
static java.lang.String	getValue(java.lang.String dataObject) Returns the value of the specified data object owned by the current user.
static java.lang.String	getValue(java.lang.String dataObject, java.lang.String user) Returns the value of the specified data object owned by the current user.
static boolean	isAvailable() Returns whether or not data objects could be used in the current environment
static void	modify(java.lang.String dataObject, java.lang.String value) Modifies the data object for the specified user with the specified value
static void	modify(java.lang.String dataObject, java.lang.String user, java.lang.String value) Modifies the data object for the specified user with the specified value
static boolean	update(DataObjectUtils.DataObjectInfo d) Modifies or adds a data object according to the properties set through the DataObjectUtils.DataObjectInfo instance.

Methods inherited from class java.lang.Object

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

Method Detail

isAvailable

public static boolean isAvailable()

Returns whether or not data objects could be used in the current environment

Returns:

True if the current matrix version is 10.7 or higher.

Since:

6.3.0

getDataObjectNames

public static java.lang.String[] getDataObjectNames()
                                             throws TVCException

Returns the dataobject names owned by the current user.

Returns:

Returns the dataobject names owned by the current user.

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

getDataObjectNames

public static java.lang.String[] getDataObjectNames(java.lang.String user)
                                             throws TVCException

Returns the dataobject names owned by the specified user.

Parameters:

user - The name of the user who owns the dataobject(s)

Returns:

Returns the dataobject names owned by the specified user.

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

exists

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

Returns true if the specified dataobject exists for the current user

Parameters:

dataObject - Then name of the data object to be added

Returns:

Returns true if the specified dataobject exists for the current user

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

exists

public static boolean exists(java.lang.String dataObject,
                             java.lang.String user)
                      throws TVCException

Returns true if the specified dataobject exists for the specified user

Parameters:

dataObject - Then name of the data object to be added

user - The name of the user who is owning the dataobject

Returns:

Returns true if the specified dataobject exists for the specified user

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

add

public static void add(java.lang.String dataObject)
                throws TVCException

Adds a new data object for the current user. The initial value will be set to empty.

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object to be added

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

add

public static void add(java.lang.String dataObject,
                       java.lang.String value)
                throws TVCException

Adds a new data object for the current user with the specified value set as the initial value.

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object to be added

value - The value of the data object

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

add

public static void add(java.lang.String dataObject,
                       java.lang.String user,
                       java.lang.String value)
                throws TVCException

Adds a new data object for the specified user with the specified value set as the initial value.

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object to be added

user - The name of the user who should own the dataobject

value - The value of the data object

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

modify

public static void modify(java.lang.String dataObject,
                          java.lang.String value)
                   throws TVCException

Modifies the data object for the specified user with the specified value

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object to be added

value - The value of the data object

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

modify

public static void modify(java.lang.String dataObject,
                          java.lang.String user,
                          java.lang.String value)
                   throws TVCException

Modifies the data object for the specified user with the specified value

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object to be modified

user - The name of the user who owns the dataobject

value - The value of the data object

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

delete

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

Deletes a new data object owned by the current user.

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object to be deleted

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

delete

public static void delete(java.lang.String dataObject,
                          java.lang.String user)
                   throws TVCException

Deletes a new data object owned by the specified user.

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object to be deleted

user - The name of the user who owns the dataobject

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

getValue

public static java.lang.String getValue(java.lang.String dataObject)
                                 throws TVCException

Returns the value of the specified data object owned by the current user.

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object

Returns:

The value of the data object

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

getValue

public static java.lang.String getValue(java.lang.String dataObject,
                                        java.lang.String user)
                                 throws TVCException

Returns the value of the specified data object owned by the current user.

Please note that you need to check if the dataobject exists or not prior calling this method.

Parameters:

dataObject - Then name of the data object

user - The name of the user who owns the dataobject

Returns:

The value of the data object

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

getModified

public static java.util.Date getModified(java.lang.String dataObject,
                                         java.lang.String user)
                                  throws TVCException

Returns the modified timestamp for a dataobject

Parameters:

dataObject - Then name of the data object

user - The name of the user who owns the dataobject

Returns:

The modified date OR null, if the dataobject doesn't exist.

Throws:

TVCException - If unable to perform the operation.

Since:

2011.1.0

getDataObjectsOfType

public static java.util.Iterator<DataObjectUtils.DataObjectInfo> getDataObjectsOfType(java.lang.String type)
                                                                               throws TVCException

Returns an iterator of the data object that has a certain type.

Parameters:

type - The type of the data objects

Returns:

An iterator of DataObjectUtils.DataObjectInfo

Throws:

TVCException

Since:

6.3.0

getDataObjectsOfType

public static java.util.Iterator<DataObjectUtils.DataObjectInfo> getDataObjectsOfType(java.lang.String type,
                                                                                      java.lang.String user)
                                                                               throws TVCException

Returns an iterator of the data object that has a certain type.

Parameters:

type - The type of the data objects

user - The name of the user owning the data objects

Returns:

An iterator of DataObjectUtils.DataObjectInfo

Throws:

TVCException

Since:

6.3.0

getDataObjectInfo

public static DataObjectUtils.DataObjectInfo getDataObjectInfo(java.lang.String name)
                                                        throws TVCException

Returns a DataObjectUtils.DataObjectInfo instance, holding the information about a data object, from the current user.

Parameters:

name - The name of the dataobject

Returns:

A DataObjectUtils.DataObjectInfo instance

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

getDataObjectInfo

public static DataObjectUtils.DataObjectInfo getDataObjectInfo(java.lang.String name,
                                                               java.lang.String user)
                                                        throws TVCException

Returns a DataObjectUtils.DataObjectInfo instance, holding the information about a data object, from the specified user.

Parameters:

name - The name of the dataobject

user - The name of the user

Returns:

A DataObjectUtils.DataObjectInfo instance

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

getDataObjectInfos

public static DataObjectUtils.DataObjectInfo[] getDataObjectInfos()
                                                           throws TVCException

Returns an array of DataObjectUtils.DataObjectInfo instances, holding the information about a data object, from the current user.

Returns:

An array of DataObjectUtils.DataObjectInfo instance (sorted according to their names)

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

getDataObjectInfos

public static DataObjectUtils.DataObjectInfo[] getDataObjectInfos(java.lang.String user)
                                                           throws TVCException

Returns an array of DataObjectUtils.DataObjectInfo instances, holding the information about a data object, from the specified user.

Parameters:

user - The name of the user

Returns:

An array of DataObjectUtils.DataObjectInfo instance (sorted according to their names)

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0

update

public static boolean update(DataObjectUtils.DataObjectInfo d)
                      throws TVCException

Modifies or adds a data object according to the properties set through the DataObjectUtils.DataObjectInfo instance.

Parameters:

d - The DataObjectUtils.DataObjectInfo instance

Returns:

True if the data object were created, false if it were modified.

Throws:

TVCException - If unable to perform the operation

Since:

6.3.0