Package ch.pschatzmann.edgar.base

Class XBRL

java.lang.Object

ch.pschatzmann.edgar.base.XBRL

All Implemented Interfaces:

java.io.Serializable

public class XBRL
extends java.lang.Object
implements java.io.Serializable

All xblr data is loaded from a file or URL into a hierarchical List of Facts where the root represents the top level of each "file" For each fact row we store the attribute values in a key-value map. The name of the XML tag is stored in the type field. The exception are the parameter values of the value xml. We store the parameter value in the "value" attribute and we name the type field as "value" as well, so that we can easily filter for all parameter records. All attribute values and the type field are indexed so that we can perform quick searches.

Author:

pschatzmann

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XBRL.SegmentScope

Field Summary

Fields

Modifier and Type	Field	Description
static Fact	EMPTY
static java.util.List	EMPTYList

Constructor Summary

Constructors

Constructor	Description
XBRL()	Default constructor
XBRL(boolean isSchemaRef, boolean isLinkbaseRef, boolean isImport)	Basic class which represents all XBRL data and provides the basic access to the data.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all related collectioins
java.util.List<Fact>	find()	Finds all child facts
java.util.List<Fact>	find(Fact.Type type)	Finds the child facts
java.util.Collection<Fact>	find(java.lang.String value)	Search text in the index
java.util.Collection<Fact>	find(java.lang.String value, Fact.Type type)	Finds all matching child facts
java.util.Collection<Fact>	find(java.lang.String value, java.util.Collection<Fact.Type> types)	Find w/o setting up the value attributes
java.util.List<Fact>	find(java.util.Collection<Fact.Type> types)	Finds the child facts
java.util.Collection<Fact>	find(java.util.Collection<java.lang.String> values, java.util.Collection<Fact.Type> types)	Find multiple values
java.util.List<FactValue>	findValues()	Finds all child value facts
java.util.List<FactValue>	findValues(Fact.DataType type)	Finds child value facts of the indicated data type
java.util.List<FactValue>	findValues(java.lang.String value)	Finds child value facts
Fact	first(java.util.Collection<Fact> facts)	Returns the first fact form the collection.
java.util.List<FactValue>	getCombinedTextValues()	Concatenates all Texts for the same date into a single text.
ICompany	getCompanyInfo()
java.lang.String	getCompanyNumber()
java.util.List<Context>	getContext(XBRL.SegmentScope scope)
java.util.List<Context>	getContext(java.lang.String dimension)	Determines the contexts for the indicated dimension
java.util.Collection<java.lang.String>	getDimensions()	Determines all existing dimensions
EdgarFiling	getFilingInfo()	Determines the information from the last filing (file name and form)
java.lang.String	getImportFileName(java.lang.String fileWithPath)	Returns the import file name for the indicated path
IndexAPI	getIndex()	Provides access to the index
LabelAPI	getLabelAPI()	Access to the LabelAPI
java.util.Collection<java.net.URL>	getLoadedURLs()	Returns all urls which were loaded either via the load method or indirectly by the system because the content of the url contains references to other urls.
int	getMaxFieldSize()
java.util.Set<java.lang.String>	getParameterNames()	Determines all parameter names
java.util.Set<java.lang.String>	getParameterNames(Fact.DataType dataType)	Determines the parameter names with the indicated type
PresentationAPI	getPresentationAPI()	Access to PresentationAPI
java.util.List<java.lang.String>	getValueAttributes()	Returns the collection of all attribute names
IValueFormatter	getValueFormatter(Fact.DataType type)
boolean	isEmpty()	Check if we have any data available.
boolean	isExtendedCompanyInformation()
boolean	isPostProcessingDone()
boolean	isSetupValueAttributes()
void	load(java.io.File file)	Loads a file or files in a directory
boolean	load(java.net.URL url)	Loads the data from the URL
XBRL	setCompanyInfo(ICompany company)
void	setCompanyNumber(java.lang.String cik)
void	setConvertHtmlToText(boolean convert)	We convert any html to text
void	setExtendedCompanyInformation(boolean extendedCompanyInformation)
void	setIgnoreHtml(boolean ignore)	We make sure that we do not store any html information to save on memory.
void	setMaxFieldSize(int maxFieldSize)
void	setPostProcessingDone(boolean postProcessingDone)
void	setSetupValueAttributes(boolean setupValueAttributes)
void	setValueFormatter(Fact.DataType type, IValueFormatter formatter)
ch.pschatzmann.common.table.ITableEx<ch.pschatzmann.common.table.Value>	toTable()	Converts all the values with an empty segment into a ITable
ch.pschatzmann.common.table.ITableEx<ch.pschatzmann.common.table.Value>	toTable(java.util.function.Predicate<FactValue> p)	Converts all the values with an empty segment into a ITable
java.lang.String	toValueCSV()	Provides the value elements as csv
void	tryLoad(java.io.File f, java.util.Collection<java.lang.Exception> errors)	Try to load a file.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static Fact EMPTY

EMPTYList

public static java.util.List EMPTYList

Constructor Detail

XBRL

public XBRL()

Default constructor

XBRL

public XBRL(boolean isSchemaRef,
            boolean isLinkbaseRef,
            boolean isImport)

Basic class which represents all XBRL data and provides the basic access to the data. It can be loaded from an url or a file.

Parameters:

isSchemaRef -

isLinkbaseRef -

isImport -

Method Detail

getLabelAPI

public LabelAPI getLabelAPI()

Access to the LabelAPI

Returns:

getPresentationAPI

public PresentationAPI getPresentationAPI()

Access to PresentationAPI

Returns:

getIndex

public IndexAPI getIndex()

Provides access to the index

Returns:

load

public void load(java.io.File file)

Loads a file or files in a directory

Parameters:

file -

tryLoad

public void tryLoad(java.io.File f,
                    java.util.Collection<java.lang.Exception> errors)

Try to load a file. Does not throw any exceptions

Parameters:

f -

errors -

load

public boolean load(java.net.URL url)
             throws org.xml.sax.SAXException,
                    java.io.IOException,
                    javax.xml.parsers.ParserConfigurationException

Loads the data from the URL

Parameters:

url -

Returns:

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getImportFileName

public java.lang.String getImportFileName(java.lang.String fileWithPath)

Returns the import file name for the indicated path

Parameters:

fileWithPath -

Returns:

getCompanyNumber

public java.lang.String getCompanyNumber()

setCompanyNumber

public void setCompanyNumber(java.lang.String cik)

find

public java.util.Collection<Fact> find(java.lang.String value,
                                       Fact.Type type)

Finds all matching child facts

Parameters:

value -

type -

Returns:

find

public java.util.Collection<Fact> find(java.lang.String value,
                                       java.util.Collection<Fact.Type> types)

Find w/o setting up the value attributes

Parameters:

value -

types -

Returns:

find

public java.util.Collection<Fact> find(java.util.Collection<java.lang.String> values,
                                       java.util.Collection<Fact.Type> types)

Find multiple values

Parameters:

values -

types -

Returns:

find

public java.util.Collection<Fact> find(java.lang.String value)

Search text in the index

Parameters:

value -

Returns:

find

public java.util.List<Fact> find()

Finds all child facts

Returns:

findValues

public java.util.List<FactValue> findValues()

Finds all child value facts

Returns:

findValues

public java.util.List<FactValue> findValues(java.lang.String value)

Finds child value facts

Returns:

findValues

public java.util.List<FactValue> findValues(Fact.DataType type)

Finds child value facts of the indicated data type

Returns:

getCombinedTextValues

public java.util.List<FactValue> getCombinedTextValues()

Concatenates all Texts for the same date into a single text. We ignore the text entries which have segment information

Returns:

getParameterNames

public java.util.Set<java.lang.String> getParameterNames(Fact.DataType dataType)
                                                  throws java.io.IOException,
                                                         org.xml.sax.SAXException,
                                                         javax.xml.parsers.ParserConfigurationException

Determines the parameter names with the indicated type

Parameters:

dataType -

Returns:

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

getParameterNames

public java.util.Set<java.lang.String> getParameterNames()
                                                  throws java.io.IOException,
                                                         org.xml.sax.SAXException,
                                                         javax.xml.parsers.ParserConfigurationException

Determines all parameter names

Returns:

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

find

public java.util.List<Fact> find(Fact.Type type)

Finds the child facts

Parameters:

type -

Returns:

find

public java.util.List<Fact> find(java.util.Collection<Fact.Type> types)

Finds the child facts

Parameters:

types -

Returns:

getLoadedURLs

public java.util.Collection<java.net.URL> getLoadedURLs()

Returns all urls which were loaded either via the load method or indirectly by the system because the content of the url contains references to other urls.

Returns:

first

public Fact first(java.util.Collection<Fact> facts)

Returns the first fact form the collection. If the collection is empty we return an empty fact node.

Parameters:

facts -

Returns:

setIgnoreHtml

public void setIgnoreHtml(boolean ignore)

We make sure that we do not store any html information to save on memory.

Parameters:

ignore -

setConvertHtmlToText

public void setConvertHtmlToText(boolean convert)

We convert any html to text

setValueFormatter

public void setValueFormatter(Fact.DataType type,
                              IValueFormatter formatter)

getValueFormatter

public IValueFormatter getValueFormatter(Fact.DataType type)

getValueAttributes

public java.util.List<java.lang.String> getValueAttributes()

Returns the collection of all attribute names

Returns:

toValueCSV

public java.lang.String toValueCSV()

Provides the value elements as csv

Returns:

getCompanyInfo

public ICompany getCompanyInfo()

setCompanyInfo

public XBRL setCompanyInfo(ICompany company)

getContext

public java.util.List<Context> getContext(XBRL.SegmentScope scope)

getContext

public java.util.List<Context> getContext(java.lang.String dimension)

Determines the contexts for the indicated dimension

Parameters:

dimension -

Returns:

getDimensions

public java.util.Collection<java.lang.String> getDimensions()

Determines all existing dimensions

Returns:

isSetupValueAttributes

public boolean isSetupValueAttributes()

setSetupValueAttributes

public void setSetupValueAttributes(boolean setupValueAttributes)

isExtendedCompanyInformation

public boolean isExtendedCompanyInformation()

setExtendedCompanyInformation

public void setExtendedCompanyInformation(boolean extendedCompanyInformation)

isPostProcessingDone

public boolean isPostProcessingDone()

setPostProcessingDone

public void setPostProcessingDone(boolean postProcessingDone)

getMaxFieldSize

public int getMaxFieldSize()

setMaxFieldSize

public void setMaxFieldSize(int maxFieldSize)

toTable

public ch.pschatzmann.common.table.ITableEx<ch.pschatzmann.common.table.Value> toTable()

Converts all the values with an empty segment into a ITable

Returns:

toTable

public ch.pschatzmann.common.table.ITableEx<ch.pschatzmann.common.table.Value> toTable(java.util.function.Predicate<FactValue> p)

Converts all the values with an empty segment into a ITable

Returns:

isEmpty

public boolean isEmpty()

Check if we have any data available. Returns true if there is no data

Returns:

getFilingInfo

public EdgarFiling getFilingInfo()

Determines the information from the last filing (file name and form)

Returns:

close

public void close()

Closes all related collectioins