weave.servlets

Class DataService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

weave.servlets.WeaveServlet

weave.servlets.DataService

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, IWeaveEntityService

public class DataService
extends WeaveServlet
implements IWeaveEntityService

This class connects to a database and gets data uses xml configuration file to get connection/query info

Author:

Andy Dufilie

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class weave.servlets.WeaveServlet

WeaveServlet.ServletRequestInfo

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_COLUMN_REQUEST_COUNT

Fields inherited from class weave.servlets.WeaveServlet

debugThreshold, JSONRPC_VERSION, METHOD, PARAMS, STREAM_PARAMETER_INDEX

Constructor Summary

Constructors

Constructor and Description
DataService()

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(java.lang.String username, java.lang.String password)
void	destroy()
int[]	findEntityIds(java.util.Map<java.lang.String,java.lang.String> publicMetadata, java.lang.String[] wildcardFields) Gets an Array of entity IDs with matching public metadata.
java.lang.String[]	findPublicFieldValues(java.lang.String fieldName, java.lang.String valueSearch) Finds matching values for a public metadata field.
AttributeColumnData	getColumn(java.lang.Object columnId, double minParam, double maxParam, java.lang.Object[] sqlParams) This retrieves the data and the public metadata for a single attribute column.
AttributeColumnData	getColumnFromMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Deprecated.
WeaveJsonDataSet	getDataSet(int[] columnIds) This function is intended for use with JsonRPC calls.
DataConfig.EntityHierarchyInfo[]	getDataTableList() Deprecated.
DataConfig.DataEntityWithRelationships[]	getEntities(int[] ids) Gets an Array of Entity objects, minus the private metadata.
DataConfig.DataEntity[]	getEntitiesById(int[] ids) Deprecated.
int[]	getEntityChildIds(int parentId) Deprecated.
int[]	getEntityIdsByMetadata(java.util.Map<java.lang.String,java.lang.String> publicMetadata, int entityType) Deprecated.
static WeaveRecordList	getFilteredRows(int[] columns, SQLUtils.WhereClause.NestedColumnFilters filters, java.lang.String[] keysArray)
byte[]	getGeometryStreamGeometryTiles(int columnId, int[] tileIDs)
byte[]	getGeometryStreamMetadataTiles(int columnId, int[] tileIDs)
DataConfig.EntityHierarchyInfo[]	getHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata) Gets EntityHierarchyInfo objects containing basic information on entities matching public metadata.
int[]	getParents(int childId) Deprecated.
WeaveRecordList	getRows(java.lang.String keyType, java.lang.String[] keysArray)
java.util.Map<java.lang.String,java.lang.Object>	getServerInfo()
TableData	getTable(int id, java.lang.Object[] sqlParams)
void	init(javax.servlet.ServletConfig config)

Methods inherited from class weave.servlets.WeaveServlet

cast, deserializeAmf3, doGet, doPost, getCapabilities, getServletRequestInfo, initAllMethods, initMethod, methodToString, serializeCompressedAmf3

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

MAX_COLUMN_REQUEST_COUNT

public static final int MAX_COLUMN_REQUEST_COUNT

See Also:

Constant Field Values

Constructor Detail

DataService

public DataService()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class WeaveServlet

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

authenticate

public void authenticate(java.lang.String username,
                java.lang.String password)
                  throws java.rmi.RemoteException

Parameters:

user -

password -

Throws:

java.rmi.RemoteException - If authentication fails.

getServerInfo

public java.util.Map<java.lang.String,java.lang.Object> getServerInfo()
                                                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getHierarchyInfo

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

Description copied from interface: IWeaveEntityService

Gets EntityHierarchyInfo objects containing basic information on entities matching public metadata.

Specified by:

getHierarchyInfo in interface IWeaveEntityService

Parameters:

publicMetadata - EntityMetadata containing values to match.

Returns:

An Array of EntityHierarchyInfo objects, sorted by title.

Throws:

java.rmi.RemoteException

getEntities

public DataConfig.DataEntityWithRelationships[] getEntities(int[] ids)
                                                     throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityService

Gets an Array of Entity objects, minus the private metadata.

Specified by:

getEntities in interface IWeaveEntityService

Parameters:

ids - A list of entity IDs.

Returns:

An Array of Entity objects.

Throws:

java.rmi.RemoteException

findEntityIds

public int[] findEntityIds(java.util.Map<java.lang.String,java.lang.String> publicMetadata,
                  java.lang.String[] wildcardFields)
                    throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityService

Gets an Array of entity IDs with matching public metadata.

Specified by:

findEntityIds in interface IWeaveEntityService

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

findPublicFieldValues

public java.lang.String[] findPublicFieldValues(java.lang.String fieldName,
                                       java.lang.String valueSearch)
                                         throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityService

Finds matching values for a public metadata field.

Specified by:

findPublicFieldValues in interface IWeaveEntityService

Parameters:

fieldName - The name of the public metadata field to search.

valueSearch - A search string.

Returns:

An Array of matching values for the specified public metadata field.

Throws:

java.rmi.RemoteException

getColumn

public AttributeColumnData getColumn(java.lang.Object columnId,
                            double minParam,
                            double maxParam,
                            java.lang.Object[] sqlParams)
                              throws java.rmi.RemoteException

This retrieves the data and the public metadata for a single attribute column.

Parameters:

columnId - Either an entity ID (int) or a Map specifying public metadata values that uniquely identify a column.

minParam - Used for filtering numeric data

maxParam - Used for filtering numeric data

sqlParams - Specifies parameters to be used in place of '?' placeholders that appear in the SQL query for the column.

Returns:

The column data.

Throws:

java.rmi.RemoteException

getTable

public TableData getTable(int id,
                 java.lang.Object[] sqlParams)
                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getDataSet

public WeaveJsonDataSet getDataSet(int[] columnIds)
                            throws java.rmi.RemoteException

This function is intended for use with JsonRPC calls.

Parameters:

columnIds - A list of column IDs.

Returns:

A WeaveJsonDataSet containing all the data from the columns.

Throws:

java.rmi.RemoteException

getGeometryStreamMetadataTiles

public byte[] getGeometryStreamMetadataTiles(int columnId,
                                    int[] tileIDs)
                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getGeometryStreamGeometryTiles

public byte[] getGeometryStreamGeometryTiles(int columnId,
                                    int[] tileIDs)
                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getRows

public WeaveRecordList getRows(java.lang.String keyType,
                      java.lang.String[] keysArray)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFilteredRows

public static WeaveRecordList getFilteredRows(int[] columns,
                              SQLUtils.WhereClause.NestedColumnFilters filters,
                              java.lang.String[] keysArray)
                                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getDataTableList

@Deprecated
public DataConfig.EntityHierarchyInfo[] getDataTableList()
                                                  throws java.rmi.RemoteException

Deprecated.

Use getHierarchyInfo() instead. This function is provided for backwards compatibility only.

Throws:

java.rmi.RemoteException

getEntityChildIds

@Deprecated
public int[] getEntityChildIds(int parentId)
                        throws java.rmi.RemoteException

Deprecated.

Use getEntities() instead. This function is provided for backwards compatibility only.

Throws:

java.rmi.RemoteException

getParents

@Deprecated
public int[] getParents(int childId)
                 throws java.rmi.RemoteException

Deprecated.

Use getEntities() instead. This function is provided for backwards compatibility only.

Throws:

java.rmi.RemoteException

getEntityIdsByMetadata

@Deprecated
public int[] getEntityIdsByMetadata(java.util.Map<java.lang.String,java.lang.String> publicMetadata,
                                      int entityType)
                             throws java.rmi.RemoteException

Deprecated.

Use findEntityIds() instead. This function is provided for backwards compatibility only.

Throws:

java.rmi.RemoteException

getEntitiesById

@Deprecated
public DataConfig.DataEntity[] getEntitiesById(int[] ids)
                                        throws java.rmi.RemoteException

Deprecated.

Use getEntities() instead. This function is provided for backwards compatibility only.

Throws:

java.rmi.RemoteException

getColumnFromMetadata

@Deprecated
public AttributeColumnData getColumnFromMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
                                          throws java.rmi.RemoteException

Deprecated.

Parameters:

metadata - The metadata query.

Returns:

The id of the matching column.

Throws:

java.rmi.RemoteException - Thrown if the metadata query does not match exactly one column.