weave.config

Class DataConfig

java.lang.Object

weave.config.DataConfig

public class DataConfig
extends java.lang.Object

DatabaseConfig This class reads from an SQL database and provides an interface to retrieve strings.

Author:

Philip Kovac, Andy Dufilie

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataConfig.DataEntity This class contains metadata for an attributeColumn entry.
static class	DataConfig.DataEntityMetadata This class contains public and private metadata for an entity.
static class	DataConfig.DataEntityWithRelationships
static class	DataConfig.DataType
static class	DataConfig.EntityHierarchyInfo
static class	DataConfig.EntityType
static class	DataConfig.PrivateMetadata
static class	DataConfig.PublicMetadata
static class	DataConfig.Relationship Represents a parent-child relationship between two entities.
static class	DataConfig.RelationshipList An ordered List of Relationship objects which adds two functions: getChildIds() and getParentIds().

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ENTITY_REQUEST_COUNT This is a recommended maximum number of entities a remote user should be able to request at a time.
static int	NULL

Constructor Summary

Constructors

Constructor and Description
DataConfig(ConnectionConfig connectionConfig)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Collection<java.lang.Integer>	buildHierarchy(int parentId, int childId, int insertAtIndex) Adds a copy of an existing child to a parent.
void	flushInserts()
java.util.List<java.lang.Integer>	getChildIds(int id) Shortcut for getRelationships(Arrays.asList(id)).getChildIds(id).
java.util.Collection<DataConfig.DataEntity>	getEntities(java.util.Collection<java.lang.Integer> ids, boolean includePrivateMetadata)
DataConfig.DataEntityWithRelationships[]	getEntitiesWithRelationships(int[] ids, boolean includePrivateMetadata)
DataConfig.DataEntity	getEntity(int id)
DataConfig.EntityHierarchyInfo[]	getEntityHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata)
java.util.Map<java.lang.Integer,java.lang.String>	getEntityTypes(java.util.Collection<java.lang.Integer> ids)
java.util.List<java.lang.Integer>	getParentIds(int id) Shortcut for getRelationships(Arrays.asList(id)).getParentIds(id).
DataConfig.RelationshipList	getRelationships(java.util.Collection<java.lang.Integer> ids) Gets a list of parent-child relationships for a set of entities.
java.util.Collection<java.lang.String>	getUniquePublicValues(java.lang.String property)
boolean	isEmpty()
int	newEntity(DataConfig.DataEntityMetadata properties, int parent_id, int insert_at_index) Creates a new entity and adds it as a child of another entity.
void	removeChild(int parent_id, int child_id)
java.util.Collection<java.lang.Integer>	removeEntities(java.util.Collection<java.lang.Integer> ids) Removes entities.
java.util.Collection<java.lang.Integer>	searchPrivateMetadata(java.util.Map<java.lang.String,java.lang.String> privateMetadata, java.lang.String[] wildcardFields) Gets an Array of entity IDs with matching public metadata.
java.util.Collection<java.lang.Integer>	searchPublicMetadata(java.util.Map<java.lang.String,java.lang.String> publicMetadata, java.lang.String[] wildcardFields) Gets an Array of entity IDs with matching public metadata.
void	updateEntity(int id, DataConfig.DataEntityMetadata diff)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ENTITY_REQUEST_COUNT

public static final int MAX_ENTITY_REQUEST_COUNT

This is a recommended maximum number of entities a remote user should be able to request at a time.

See Also:

Constant Field Values

NULL

public static final int NULL

See Also:

Constant Field Values

Constructor Detail

DataConfig

public DataConfig(ConnectionConfig connectionConfig)
           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

isEmpty

public boolean isEmpty()
                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

flushInserts

public void flushInserts()
                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

newEntity

public int newEntity(DataConfig.DataEntityMetadata properties,
            int parent_id,
            int insert_at_index)
              throws java.rmi.RemoteException

Creates a new entity and adds it as a child of another entity.

Parameters:

properties - Metadata for the new entity.

parent_id - The ID of the parent entity to which the new entity should be added as a child, or NULL for no parent.

insert_at_index - The new entity's child index, or NULL to add it to the end.

Returns:

The new entity's ID.

Throws:

java.rmi.RemoteException

removeEntities

public java.util.Collection<java.lang.Integer> removeEntities(java.util.Collection<java.lang.Integer> ids)
                                                       throws java.rmi.RemoteException

Removes entities.

Parameters:

ids - A list of IDs specifying entities to remove.

Returns:

A collection of IDs that were removed.

Throws:

java.rmi.RemoteException

updateEntity

public void updateEntity(int id,
                DataConfig.DataEntityMetadata diff)
                  throws java.rmi.RemoteException

Parameters:

id - The id of an existing entity.

diff - The properties to set.

Throws:

java.rmi.RemoteException

searchPublicMetadata

public java.util.Collection<java.lang.Integer> searchPublicMetadata(java.util.Map<java.lang.String,java.lang.String> publicMetadata,
                                                           java.lang.String[] wildcardFields)
                                                             throws java.rmi.RemoteException

Gets an Array of entity IDs with matching public metadata.

Parameters:

publicMetadata - Public metadata to search for.

wildcardFields - A list of field names in publicMetadata that should be treated as search strings with wildcards '?' and '*' for single-character and multi-character matching, respectively.

Returns:

An Array of IDs matching the search criteria.

Throws:

java.rmi.RemoteException

searchPrivateMetadata

public java.util.Collection<java.lang.Integer> searchPrivateMetadata(java.util.Map<java.lang.String,java.lang.String> privateMetadata,
                                                            java.lang.String[] wildcardFields)
                                                              throws java.rmi.RemoteException

Gets an Array of entity IDs with matching public metadata.

Parameters:

privateMetadata - Public metadata to search for.

wildcardFields - A list of field names in publicMetadata that should be treated as search strings with wildcards '?' and '*' for single-character and multi-character matching, respectively.

Returns:

An Array of IDs matching the search criteria.

Throws:

java.rmi.RemoteException

getEntity

public DataConfig.DataEntity getEntity(int id)
                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getEntities

public java.util.Collection<DataConfig.DataEntity> getEntities(java.util.Collection<java.lang.Integer> ids,
                                                      boolean includePrivateMetadata)
                                                        throws java.rmi.RemoteException

Parameters:

ids - A collection of entity ids.

includePrivateMetadata - Set this to true to include private metadata in the results.

Returns:

A collection of DataEntity objects for the entities in the supplied list of ids that actually exist.

Throws:

java.rmi.RemoteException

getEntitiesWithRelationships

public DataConfig.DataEntityWithRelationships[] getEntitiesWithRelationships(int[] ids,
                                                                    boolean includePrivateMetadata)
                                                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

buildHierarchy

public java.util.Collection<java.lang.Integer> buildHierarchy(int parentId,
                                                     int childId,
                                                     int insertAtIndex)
                                                       throws java.rmi.RemoteException

Adds a copy of an existing child to a parent.

Parameters:

parentId - An existing parent to add a child hierarchy to.

childId - An existing child to copy the hierarchy of.

insertAtIndex - Identifies a child of the parent to insert the new child before.

Returns:

A collection of IDs whose relationships have changed as a result of modifying the hierarchy.

Throws:

java.rmi.RemoteException

removeChild

public void removeChild(int parent_id,
               int child_id)
                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getEntityTypes

public java.util.Map<java.lang.Integer,java.lang.String> getEntityTypes(java.util.Collection<java.lang.Integer> ids)
                                                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getParentIds

public java.util.List<java.lang.Integer> getParentIds(int id)
                                               throws java.rmi.RemoteException

Shortcut for getRelationships(Arrays.asList(id)).getParentIds(id). If you need this information for multiple IDs, use getRelationships() instead.

Throws:

java.rmi.RemoteException

See Also:

getRelationships(Collection)

getChildIds

public java.util.List<java.lang.Integer> getChildIds(int id)
                                              throws java.rmi.RemoteException

Shortcut for getRelationships(Arrays.asList(id)).getChildIds(id). If you need this information for multiple IDs, use getRelationships() instead.

Throws:

java.rmi.RemoteException

See Also:

getRelationships(Collection)

getRelationships

public DataConfig.RelationshipList getRelationships(java.util.Collection<java.lang.Integer> ids)
                                             throws java.rmi.RemoteException

Gets a list of parent-child relationships for a set of entities.

Parameters:

ids - A collection of entity IDs.

Returns:

An ordered list of parent-child relationships involving the specified entities.

Throws:

java.rmi.RemoteException

getUniquePublicValues

public java.util.Collection<java.lang.String> getUniquePublicValues(java.lang.String property)
                                                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getEntityHierarchyInfo

public DataConfig.EntityHierarchyInfo[] getEntityHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata)
                                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException