com.technia.tvc.core.db

Class SetUtils

java.lang.Object

com.technia.tvc.core.db.SetUtils

public final class SetUtils
extends java.lang.Object

Contains some useful methods that helps when using matrix sets.

Method Summary

Modifier and Type	Method and Description
static void	changeName(java.lang.String setName, java.lang.String newSetName) Changes the name of a set.
static boolean	createSet(java.lang.String setName, java.lang.String description) Creates a new set, and sets the description of the set.
static boolean	createSet(java.lang.String user, java.lang.String setName, java.lang.String description)
static boolean	deleteSet(java.lang.String setName) Returns true, if the named collection was deleted.
static boolean	deleteSet(java.lang.String user, java.lang.String setName)
static boolean	deleteSets(java.lang.String[] setNames) Deletes the specified sets.
static void	distribute(java.lang.String setName, java.lang.String newName, java.lang.String toUser, boolean overwrite) Distributes a set to another user.
static boolean	exists(java.lang.String setName) Returns true, if the named collection exists.
static boolean	exists(java.lang.String user, java.lang.String setName) Returns true, if the named collection exists.
static java.lang.String	getDescription(java.lang.String setName) Returns the description for a set.
static java.lang.String[]	getObjectIdsFromSet(java.lang.String setName) Returns the ids of the businessobjects in the specified set.
static java.lang.String[]	getObjectIdsFromSet(java.lang.String user, java.lang.String setName) Returns the ids of the businessobjects in the specified set.
static java.lang.String	getProperty(java.lang.String setName, java.lang.String propertyName) Returns the value of a property.
static java.lang.String[]	listSets() Returns the names of the different sets the current user has.
static java.lang.String[]	listSets(boolean hidden)
static java.lang.String[]	listSets(java.lang.String user) Returns the names of the different sets a specific user has.
static java.lang.String[]	listStructures(boolean hidden) Returns the names of the different structures a user has.
static void	mergeSets(java.lang.String[] setNames, java.lang.String targetSetName, boolean append) Merges a couple of sets together.
static void	mergeSets(java.lang.String[] setNames, java.lang.String targetSetName, boolean append, boolean keepOld) Merges a couple of sets together.
static void	purgeSet(java.lang.String setName) Removes the items in a set
static void	purgeSet(java.lang.String user, java.lang.String name) Removes the items in a set
static boolean	removeFromSet(java.lang.String setName, java.lang.String[] objectIds) Removes items from a set.
static boolean	removeFromSet(java.lang.String user, java.lang.String setName, java.lang.String[] objectIds)
static void	saveObjectIntoSet(java.lang.String setName, java.lang.String objectId, boolean append)
static void	saveObjectIntoSet(java.lang.String user, java.lang.String setName, java.lang.String objectId, boolean append)
static void	saveObjectsIntoSet(java.lang.String setName, java.util.Collection<java.lang.String> objectIds, boolean append)
static void	saveObjectsIntoSet(java.lang.String setName, java.lang.String[] objectIds, boolean append) Saves the specified objects into a named set.
static void	saveObjectsIntoSet(java.lang.String user, java.lang.String setName, java.util.Collection<java.lang.String> objectIds, boolean append)
static void	saveObjectsIntoSet(java.lang.String user, java.lang.String setName, java.lang.String[] objectIds, boolean append)
static void	setDescription(java.lang.String setName, java.lang.String description) Sets the description for a set.
static void	setDescription(java.lang.String user, java.lang.String setName, java.lang.String description)
static void	setProperty(java.lang.String setName, java.lang.String propertyName, java.lang.String propertyValue) Sets the value of a property.
static void	setProperty(java.lang.String user, java.lang.String setName, java.lang.String propertyName, java.lang.String propertyValue) Sets the value of a property.
static void	validateName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Method Detail

getObjectIdsFromSet

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

Returns the ids of the businessobjects in the specified set. Note that the set must exist in the database or this operation will fail.

Throws:

TVCException

Since:

4.1.0

getObjectIdsFromSet

public static java.lang.String[] getObjectIdsFromSet(java.lang.String user,
                                                     java.lang.String setName)
                                              throws TVCException

Returns the ids of the businessobjects in the specified set. Note that the set must exist in the database or this operation will fail.

Parameters:

user - The user owning the set

setName - The name of the set

Throws:

TVCException

Since:

6.3.0

listStructures

public static java.lang.String[] listStructures(boolean hidden)
                                         throws TVCException

Returns the names of the different structures a user has.

Throws:

TVCException

listSets

public static java.lang.String[] listSets(boolean hidden)
                                   throws TVCException

Throws:

TVCException

listSets

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

Returns the names of the different sets the current user has.

Throws:

TVCException

Since:

6.3.0

listSets

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

Returns the names of the different sets a specific user has.

Parameters:

user - The name of the user owning the listed sets.

Throws:

TVCException

Since:

6.3.0

exists

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

Returns true, if the named collection exists.

Parameters:

setName - The name of the collection

Returns:

True if it exists.

Throws:

TVCException - Upon datbase problem

Since:

5.0

exists

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

Returns true, if the named collection exists.

Parameters:

user - The user

setName - The name of the collection

Returns:

True if it exists.

Throws:

TVCException - Upon datbase problem

Since:

6.3.0

purgeSet

public static void purgeSet(java.lang.String user,
                            java.lang.String name)
                     throws TVCException

Removes the items in a set

Parameters:

user - The user owning the set

name - The name of the set.

Throws:

TVCException

Since:

6.3.0

purgeSet

public static void purgeSet(java.lang.String setName)
                     throws TVCException

Removes the items in a set

Parameters:

setName - The name of the set.

Throws:

TVCException

saveObjectsIntoSet

public static void saveObjectsIntoSet(java.lang.String setName,
                                      java.lang.String[] objectIds,
                                      boolean append)
                               throws TVCException

Saves the specified objects into a named set.

Parameters:

setName -

objectIds -

append -

Throws:

TVCException

Since:

5.0

saveObjectIntoSet

public static void saveObjectIntoSet(java.lang.String setName,
                                     java.lang.String objectId,
                                     boolean append)
                              throws TVCException

Parameters:

setName - the name of the set

objectId - the objectId

append - true to append otherwise purge the set first

Throws:

TVCException - if an exception occurs during the save operation

Since:

2011.3.0

saveObjectsIntoSet

public static void saveObjectsIntoSet(java.lang.String setName,
                                      java.util.Collection<java.lang.String> objectIds,
                                      boolean append)
                               throws TVCException

Throws:

TVCException

saveObjectsIntoSet

public static void saveObjectsIntoSet(java.lang.String user,
                                      java.lang.String setName,
                                      java.lang.String[] objectIds,
                                      boolean append)
                               throws TVCException

Throws:

TVCException

saveObjectIntoSet

public static void saveObjectIntoSet(java.lang.String user,
                                     java.lang.String setName,
                                     java.lang.String objectId,
                                     boolean append)
                              throws TVCException

Parameters:

user - the name of the user

setName - the name of the set

objectId - the objectId

append - true to append otherwise purge the set first

Throws:

TVCException - if an exception occurs during the save operation

Since:

2011.3.0

saveObjectsIntoSet

public static void saveObjectsIntoSet(java.lang.String user,
                                      java.lang.String setName,
                                      java.util.Collection<java.lang.String> objectIds,
                                      boolean append)
                               throws TVCException

Throws:

TVCException

deleteSets

public static boolean deleteSets(java.lang.String[] setNames)
                          throws TVCException

Deletes the specified sets. If all sets were deleted, true is returned. If at least one set couldn't be deleted, false is returned.

Parameters:

setNames - The names of the sets that should be deleted.

Returns:

Returns whether or not all sets were deleted. I.e, a set will not be deleted if it didn't exist prior to calling this method.

Throws:

TVCException - If an error occurs while deleting a set.

Since:

5.0

deleteSet

public static boolean deleteSet(java.lang.String setName)
                         throws TVCException

Returns true, if the named collection was deleted.

Parameters:

setName - The name of the collection

Returns:

Returns whether or not the set was deleted (i.e., if the set existed prior to calling this method).

Throws:

TVCException - If unable to delete the set.

Since:

5.0

deleteSet

public static boolean deleteSet(java.lang.String user,
                                java.lang.String setName)
                         throws TVCException

Throws:

TVCException

mergeSets

public static void mergeSets(java.lang.String[] setNames,
                             java.lang.String targetSetName,
                             boolean append)
                      throws TVCException

Merges a couple of sets together.

Parameters:

setNames - The sets to be merged

targetSetName - The name of the set, to which the objects will be merged.

append - If the target set exists, the append flag defines if the objects should be appended to the set, or, replace the existing objects within the set (if there were any).

Throws:

TVCException

TVCException - Upon datbase problem

Since:

5.0

mergeSets

public static void mergeSets(java.lang.String[] setNames,
                             java.lang.String targetSetName,
                             boolean append,
                             boolean keepOld)
                      throws TVCException

Merges a couple of sets together.

Parameters:

setNames - The sets to be merged

targetSetName - The name of the set, to which the objects will be merged.

append - If the target set exists, the append flag defines if the objects should be appended to the set, or, replace the existing objects within the set (if there were any).

keepOld - True if the sets should be kept as is.

Throws:

TVCException

TVCException - Upon datbase problem

Since:

5.2.2

removeFromSet

public static boolean removeFromSet(java.lang.String setName,
                                    java.lang.String[] objectIds)
                             throws TVCException

Removes items from a set.

Parameters:

setName -

objectIds -

Throws:

TVCException

Since:

5.0

removeFromSet

public static boolean removeFromSet(java.lang.String user,
                                    java.lang.String setName,
                                    java.lang.String[] objectIds)
                             throws TVCException

Throws:

TVCException

createSet

public static boolean createSet(java.lang.String setName,
                                java.lang.String description)
                         throws TVCException

Creates a new set, and sets the description of the set.

Returns:

True if the set was created.

Throws:

TVCException

Since:

5.0

createSet

public static boolean createSet(java.lang.String user,
                                java.lang.String setName,
                                java.lang.String description)
                         throws TVCException

Throws:

TVCException

getDescription

public static java.lang.String getDescription(java.lang.String setName)
                                       throws TVCException

Returns the description for a set. The description is stored as a property, with name "description", on the set. This is the same approach as the AEF uses.

Parameters:

setName - The name of the set.

Throws:

TVCException

Since:

5.0

setDescription

public static void setDescription(java.lang.String setName,
                                  java.lang.String description)
                           throws TVCException

Sets the description for a set. The description is stored as a property, with name "description", on the set. This is the same approach as the AEF uses.

Parameters:

setName - The name of the set.

description - The description to set.

Throws:

TVCException

Since:

5.0

setDescription

public static void setDescription(java.lang.String user,
                                  java.lang.String setName,
                                  java.lang.String description)
                           throws TVCException

Throws:

TVCException

getProperty

public static java.lang.String getProperty(java.lang.String setName,
                                           java.lang.String propertyName)
                                    throws TVCException

Returns the value of a property.

Parameters:

setName - The name of the set.

propertyName - The name of the property.

Returns:

The value of the property, or null if the property doesn't exist.

Throws:

TVCException - If unable to get the property value.

Since:

2009.1

setProperty

public static void setProperty(java.lang.String setName,
                               java.lang.String propertyName,
                               java.lang.String propertyValue)
                        throws TVCException

Sets the value of a property.

Parameters:

setName - The name of the set.

propertyName - The name of the property.

propertyValue - The value.

Throws:

TVCException - If unable to set the property value.

Since:

2009.1

setProperty

public static void setProperty(java.lang.String user,
                               java.lang.String setName,
                               java.lang.String propertyName,
                               java.lang.String propertyValue)
                        throws TVCException

Sets the value of a property.

Parameters:

user - The user that owns the set.

setName - The name of the set.

propertyName - The name of the property.

propertyValue - The value.

Throws:

TVCException - If unable to set the property value.

Since:

2009.1

changeName

public static void changeName(java.lang.String setName,
                              java.lang.String newSetName)
                       throws TVCException

Changes the name of a set.

Parameters:

setName -

newSetName -

Throws:

TVCException

Since:

5.2.2

distribute

public static void distribute(java.lang.String setName,
                              java.lang.String newName,
                              java.lang.String toUser,
                              boolean overwrite)
                       throws TVCException

Distributes a set to another user.

Parameters:

setName - The name of the set to distribute

toUser - The user to whome the set will be distributed

newName - The new name, or null if to auto-generate the new name.

overwrite - True to overwrite existing.

Throws:

TVCException - If unable to distribute the Set.

Since:

5.0

validateName

public static void validateName(java.lang.String name)
                         throws TVCException

Throws:

TVCException