Package ch.pschatzmann.edgar.service

Class EdgarFileService

java.lang.Object

ch.pschatzmann.edgar.service.EdgarFileService

All Implemented Interfaces:

java.io.Serializable

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

REST service which provides the content of xbrl files as json

Author:

pschatzmann

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EdgarFileService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	classification(java.lang.String filingRegex, boolean fast, boolean withTradingSymbolOnly, long limit)	Returns the Label and Parent Labels.
ICompany	company(java.lang.String cikNumber, java.lang.String filing)	Provides the company information from a filing
java.util.List<Context>	context(java.lang.String cikNumber, java.lang.String filing, XBRL.SegmentScope scope)	Provides the context information from the filing
javax.ws.rs.core.Response	filing(javax.ws.rs.core.HttpHeaders headers, java.lang.String filing, Fact.DataType dataType)	Returns the values nodes of an individual filing
static java.util.List<java.lang.String>	getCompanies()	Determines all existing companies (cik numbers)
static java.io.File	getFile(java.lang.String filing)
static java.util.List<java.lang.String>	getFilings(java.lang.String cikNumberOrFiling)	Returns the filings for the indicated company
java.util.List<java.lang.String>	getFilings(java.lang.String companyNr, boolean fast)	Determines all filings for a company (identified by the cikNumber)
XBRL	getXBRL(java.lang.String filing)
XBRL	getXBRL(java.util.Collection<java.lang.String> filings)
XBRL	getXBRL(java.util.Collection<java.lang.String> filings, int maxLength)
java.util.List<Presentation>	presentation(java.lang.String cikNumber, java.lang.String filing, boolean specialAxis)	Returns the presentation information from a filing
javax.ws.rs.core.Response	values(javax.ws.rs.core.HttpHeaders headers, java.lang.String filing, Fact.DataType dataType)	Returns the values nodes of an individual filing

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgarFileService

public EdgarFileService()

Method Detail

getCompanies

@GET
@Path("/companies")
@Produces("application/json")
public static java.util.List<java.lang.String> getCompanies()
                                                     throws java.lang.Exception

Determines all existing companies (cik numbers)

Returns:

Throws:

java.io.IOException

java.lang.Exception

getFilings

@GET
@Path("/filings/{companyNr}")
@Produces("application/json")
public java.util.List<java.lang.String> getFilings(@PathParam("companyNr")
                                                   java.lang.String companyNr,
                                                   @PathParam("fast") @DefaultValue("false")
                                                   boolean fast)
                                            throws java.lang.Exception

Determines all filings for a company (identified by the cikNumber)

Parameters:

companyNr -

fast -

Returns:

Throws:

java.lang.Exception

values

@GET
@Path("/values/{filing}")
@Produces("application/json")
public javax.ws.rs.core.Response values(@Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @PathParam("filing")
                                        java.lang.String filing,
                                        @QueryParam("dataType")
                                        Fact.DataType dataType)
                                 throws java.lang.Exception

Returns the values nodes of an individual filing

Parameters:

headers -

filing -

dataType -

Returns:

Throws:

java.lang.Exception

filing

@GET
@Path("/file/{filing}")
@Produces("application/zip")
public javax.ws.rs.core.Response filing(@Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @PathParam("filing")
                                        java.lang.String filing,
                                        @QueryParam("dataType")
                                        Fact.DataType dataType)
                                 throws java.lang.Exception

Returns the values nodes of an individual filing

Parameters:

headers -

filing -

dataType -

Returns:

Throws:

java.lang.Exception

presentation

@GET
@Path("/presentation/{filing}")
@Produces("application/json")
public java.util.List<Presentation> presentation(@PathParam("companyNr")
                                                 java.lang.String cikNumber,
                                                 @PathParam("filing")
                                                 java.lang.String filing,
                                                 @QueryParam("specialAxis") @DefaultValue("false")
                                                 boolean specialAxis)
                                          throws java.lang.Exception

Returns the presentation information from a filing

Parameters:

cikNumber -

filing -

specialAxis -

Returns:

Throws:

java.lang.Exception

company

@GET
@Path("/company/{filing}")
@Produces("application/json")
public ICompany company(@PathParam("companyNr")
                        java.lang.String cikNumber,
                        @PathParam("filing")
                        java.lang.String filing)
                 throws java.lang.Exception

Provides the company information from a filing

Parameters:

cikNumber -

filing -

Returns:

Throws:

java.lang.Exception

context

@GET
@Path("/context/{filing}")
@Produces("application/json")
public java.util.List<Context> context(@PathParam("companyNr")
                                       java.lang.String cikNumber,
                                       @PathParam("filing")
                                       java.lang.String filing,
                                       @QueryParam("segmentScope") @DefaultValue("WithoutSegments")
                                       XBRL.SegmentScope scope)
                                throws java.lang.Exception

Provides the context information from the filing

Parameters:

cikNumber -

filing -

scope -

Returns:

Throws:

java.lang.Exception

classification

@GET
@Path("/classification")
@Produces("text/plain")
public javax.ws.rs.core.Response classification(@QueryParam("filingRegex") @DefaultValue(".*10-K.*")
                                                java.lang.String filingRegex,
                                                @QueryParam("fast") @DefaultValue("true")
                                                boolean fast,
                                                @QueryParam("withTradingSymbolOnly") @DefaultValue("true")
                                                boolean withTradingSymbolOnly,
                                                @QueryParam("limit")
                                                long limit)
                                         throws java.lang.Exception

Returns the Label and Parent Labels. This is intended to be used as input for a Neural Network in order to a classification

Parameters:

filingRegex -

Returns:

Throws:

java.lang.Exception

getFilings

public static java.util.List<java.lang.String> getFilings(java.lang.String cikNumberOrFiling)

Returns the filings for the indicated company

Parameters:

cikNumberOrFiling -

Returns:

getFile

public static java.io.File getFile(java.lang.String filing)

getXBRL

public XBRL getXBRL(java.lang.String filing)
             throws org.xml.sax.SAXException,
                    java.io.IOException,
                    javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getXBRL

public XBRL getXBRL(java.util.Collection<java.lang.String> filings)
             throws org.xml.sax.SAXException,
                    java.io.IOException,
                    javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getXBRL

public XBRL getXBRL(java.util.Collection<java.lang.String> filings,
                    int maxLength)
             throws org.xml.sax.SAXException,
                    java.io.IOException,
                    javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException