Package ch.pschatzmann.edgar.service

Class EdgarDBService

java.lang.Object

ch.pschatzmann.edgar.service.EdgarDBService

All Implemented Interfaces:

java.io.Serializable

@Path("/edgar/db")
public class EdgarDBService
extends java.lang.Object
implements java.io.Serializable

REST webservice which provides access to the EdgarModel under the url /edgar. E.g. /edgar/groups provides the list of all groups

Author:

pschatzmann

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EdgarDBService.PeriodFilter

Constructor Summary

Constructors

Constructor	Description
EdgarDBService()	Constructor

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	companyValues(javax.ws.rs.core.HttpHeaders headers, java.lang.String requestedFormat, java.lang.String identifier, java.lang.String tradingSymbol, EdgarDBService.PeriodFilter periods, java.util.List<java.lang.String> parameterNames, javax.ws.rs.core.UriInfo uriInfo)	Provides as a result the information for a company as a table where the columns represent parameters and the rows the period data.
javax.ws.rs.core.Response	companyValuesPost(javax.ws.rs.core.HttpHeaders headers, CompanyValues req, javax.ws.rs.core.UriInfo uriInfo)	Provides as a result the information for a company as a table where the columns represent parameters and the rows the period data.
WSField	field(java.lang.String field, java.lang.String table, java.lang.String relationFromField)	finds an individual field
javax.ws.rs.core.Response	fieldsForGroup(java.lang.String group)	Finds all fields for a field group
javax.ws.rs.core.Response	fieldValues(java.lang.String fieldName, java.lang.String tableName, java.lang.String like, int count)	Returns all available field values
javax.ws.rs.core.Response	groups()	Provides the list of all field groups
NavigationField	toNavigationField(WSField fld)	Convert wrapper class to NavigationField
javax.ws.rs.core.Response	values(javax.ws.rs.core.HttpHeaders headers, java.lang.String requestedFormat, java.lang.String row, java.lang.String col, java.lang.String parameterCSV, boolean parameterAsAlternative, int n, javax.ws.rs.core.UriInfo uriInfo)	Query the Edgar database and summarize the results by the indicated columns and rows.
javax.ws.rs.core.Response	valuesPost(javax.ws.rs.core.HttpHeaders headers, Query query)	Query the edgar database and summarize the results by the indicated columns and rows

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgarDBService

public EdgarDBService()
               throws DataException

Constructor

Throws:

DataException

Method Detail

groups

@GET
@Path("fieldGroups")
@Produces("application/json")
public javax.ws.rs.core.Response groups()
                                 throws java.io.IOException,
                                        java.lang.Exception

Provides the list of all field groups

Returns:

Throws:

java.io.IOException

java.lang.Exception

fieldsForGroup

@GET
@Path("fields")
@Produces("application/json")
public javax.ws.rs.core.Response fieldsForGroup(@QueryParam("group")
                                                java.lang.String group)
                                         throws java.io.IOException,
                                                java.lang.Exception

Finds all fields for a field group

Parameters:

group -

Returns:

Throws:

java.io.IOException

java.lang.Exception

field

@GET
@Path("field/{fieldname}")
@Produces("application/json")
public WSField field(@PathParam("fieldname")
                     java.lang.String field,
                     @QueryParam("table")
                     java.lang.String table,
                     @QueryParam("relationField")
                     java.lang.String relationFromField)
              throws java.io.IOException,
                     java.lang.Exception

finds an individual field

Parameters:

field -

table -

relationFromField -

Returns:

Throws:

java.io.IOException

java.lang.Exception

values

@GET
@Path("values")
@Produces({"application/json","text/plain","text/html","application/x-sql"})
public javax.ws.rs.core.Response values(@Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @QueryParam("format")
                                        java.lang.String requestedFormat,
                                        @DefaultValue("country") @QueryParam("row")
                                        java.lang.String row,
                                        @DefaultValue("year") @QueryParam("col")
                                        java.lang.String col,
                                        @QueryParam("parameter")
                                        java.lang.String parameterCSV,
                                        @QueryParam("alt")
                                        boolean parameterAsAlternative,
                                        @DefaultValue("20") @QueryParam("n")
                                        int n,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo)
                                 throws DataException,
                                        java.lang.ClassNotFoundException,
                                        java.sql.SQLException,
                                        ch.pschatzmann.common.table.FormatException

Query the Edgar database and summarize the results by the indicated columns and rows. We support only then empty segmentDimension

Parameters:

headers -

requestedFormat -

row -

col -

parameterCSV -

parameterAsAlternative -

n -

uriInfo -

Returns:

Throws:

DataException

java.sql.SQLException

java.lang.ClassNotFoundException

ch.pschatzmann.common.table.FormatException

valuesPost

@POST
@Path("values")
@Consumes("application/json")
@Produces({"application/json","text/plain","text/html","application/x-sql"})
public javax.ws.rs.core.Response valuesPost(@Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            Query query)
                                     throws DataException,
                                            ch.pschatzmann.common.table.FormatException,
                                            java.lang.ClassNotFoundException,
                                            java.sql.SQLException

Query the edgar database and summarize the results by the indicated columns and rows

Parameters:

headers -

query -

Returns:

Throws:

DataException

ch.pschatzmann.common.table.FormatException

java.sql.SQLException

java.lang.ClassNotFoundException

fieldValues

@GET
@Path("fieldValues/{fieldname}")
@Produces("application/json")
public javax.ws.rs.core.Response fieldValues(@PathParam("fieldname")
                                             java.lang.String fieldName,
                                             @QueryParam("table")
                                             java.lang.String tableName,
                                             @QueryParam("like")
                                             java.lang.String like,
                                             @DefaultValue("1000") @QueryParam("count")
                                             int count)
                                      throws DataException

Returns all available field values

Parameters:

fieldName -

tableName -

like -

count -

Returns:

Throws:

DataException

toNavigationField

public NavigationField toNavigationField(WSField fld)
                                  throws DataException

Convert wrapper class to NavigationField

Parameters:

fld -

Returns:

Throws:

DataException

companyValues

@GET
@Path("companyValues")
@Produces({"application/json","text/plain","text/html","application/x-sql"})
public javax.ws.rs.core.Response companyValues(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @QueryParam("format")
                                               java.lang.String requestedFormat,
                                               @QueryParam("identifier")
                                               java.lang.String identifier,
                                               @QueryParam("tradingSymbol")
                                               java.lang.String tradingSymbol,
                                               @QueryParam("periods") @DefaultValue("Y")
                                               EdgarDBService.PeriodFilter periods,
                                               @QueryParam("parameters")
                                               java.util.List<java.lang.String> parameterNames,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo)
                                        throws DataException,
                                               java.lang.ClassNotFoundException,
                                               java.sql.SQLException,
                                               ch.pschatzmann.common.table.FormatException

Provides as a result the information for a company as a table where the columns represent parameters and the rows the period data.

Parameters:

headers -

requestedFormat -

identifier -

tradingSymbol -

periods -

parameterNames -

uriInfo -

Returns:

Throws:

DataException

java.lang.ClassNotFoundException

java.sql.SQLException

ch.pschatzmann.common.table.FormatException

companyValuesPost

@POST
@Path("companyValues")
@Produces({"application/json","text/plain","text/html","application/x-sql"})
public javax.ws.rs.core.Response companyValuesPost(@Context
                                                   javax.ws.rs.core.HttpHeaders headers,
                                                   CompanyValues req,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo)
                                            throws DataException,
                                                   java.lang.ClassNotFoundException,
                                                   java.sql.SQLException,
                                                   ch.pschatzmann.common.table.FormatException

Provides as a result the information for a company as a table where the columns represent parameters and the rows the period data. We also support calculated parameter values

Parameters:

headers -

req -

uriInfo -

Returns:

Throws:

DataException

java.lang.ClassNotFoundException

java.sql.SQLException

ch.pschatzmann.common.table.FormatException