Package ch.pschatzmann.edgar.base

Class EdgarFiling

java.lang.Object

ch.pschatzmann.edgar.base.EdgarFiling

public class EdgarFiling
extends java.lang.Object

Simple API to provide access to File filings

Author:

pschatzmann

Constructor Summary

Constructors

Constructor	Description
EdgarFiling(java.lang.String filing)

Method Summary

Modifier and Type	Method	Description
EdgarCompany	getCompanyInfo()	Provides the CompanyInfo for the filing
java.lang.String	getDate()	Provides the date as yyyy-MM-dd
java.util.List<java.lang.String>	getEntries()	Returns the entries of the zip reporting file
java.io.File	getFile()	Returns the file of the filing
java.lang.String	getFileName()	Provides the filing id
java.lang.String	getForm()	Determines the form
XBRL	getXBRL()	Determines the XBRL
static XBRL	getXBRL(java.util.Collection<EdgarFiling> filings)	Loads the indicated filings into one combined XBRL
static java.util.List<EdgarFiling>	list(java.lang.String regex)	Finds all filings which exist in the file system
void	setForm(java.lang.String form)	Defines the form
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgarFiling

public EdgarFiling(java.lang.String filing)

Method Detail

getFile

public java.io.File getFile()

Returns the file of the filing

Returns:

list

public static java.util.List<EdgarFiling> list(java.lang.String regex)
                                        throws java.lang.Exception

Finds all filings which exist in the file system

Parameters:

regex -

Returns:

Throws:

java.lang.Exception

getXBRL

public static XBRL getXBRL(java.util.Collection<EdgarFiling> filings)

Loads the indicated filings into one combined XBRL

Parameters:

filings -

Returns:

getXBRL

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

Determines the XBRL

Returns:

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

getEntries

public java.util.List<java.lang.String> getEntries()
                                            throws java.util.zip.ZipException,
                                                   java.io.IOException

Returns the entries of the zip reporting file

Returns:

Throws:

java.io.IOException

java.util.zip.ZipException

getCompanyInfo

public EdgarCompany getCompanyInfo()

Provides the CompanyInfo for the filing

Returns:

getDate

public java.lang.String getDate()

Provides the date as yyyy-MM-dd

Returns:

getFileName

public java.lang.String getFileName()

Provides the filing id

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setForm

public void setForm(java.lang.String form)

Defines the form

Parameters:

form -

getForm

public java.lang.String getForm()

Determines the form

Returns: