Package ch.pschatzmann.edgar.base

Class PresentationAPI

java.lang.Object

ch.pschatzmann.edgar.base.PresentationAPI

All Implemented Interfaces:

java.io.Serializable

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

API for the presentation layer. This is represented by a hierarchical tree of Presentation objects.

Author:

pschatzmann

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
void	close()	Release memory from collections
java.util.Collection<Presentation>	findPresentationsForParameter(java.lang.String parameterName)	Determines the presentations for a parameter
java.util.List<Presentation>	getChildren()	Get all direct children
java.util.List<Presentation>	getChildrenEx()	Returns all exploded rows in inorder sequence starting from the root.
Presentation	getPresentation(java.lang.String viewName)	Finds the Presentation by the name
Presentation	getRoot()	Returns the Root for all Presentations
XBRL	getXBRL()	Returns a reference to the main XBRL
boolean	isSuppressEmptyRows()	Determines if empty rows should be suppressed
void	setSuppressEmptyRows(boolean suppressEmptyRows)	Defines that the empty rows should be suppressed
java.lang.String	toJson()

Methods inherited from class java.lang.Object

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

Method Detail

getXBRL

public XBRL getXBRL()

Returns a reference to the main XBRL

Returns:

getChildrenEx

public java.util.List<Presentation> getChildrenEx()

Returns all exploded rows in inorder sequence starting from the root.

Returns:

getChildren

public java.util.List<Presentation> getChildren()

Get all direct children

Returns:

getPresentation

public Presentation getPresentation(java.lang.String viewName)

Finds the Presentation by the name

Parameters:

viewName -

Returns:

findPresentationsForParameter

public java.util.Collection<Presentation> findPresentationsForParameter(java.lang.String parameterName)

Determines the presentations for a parameter

Parameters:

parameterName -

Returns:

getRoot

public Presentation getRoot()

Returns the Root for all Presentations

Returns:

isSuppressEmptyRows

public boolean isSuppressEmptyRows()

Determines if empty rows should be suppressed

Returns:

setSuppressEmptyRows

public void setSuppressEmptyRows(boolean suppressEmptyRows)

Defines that the empty rows should be suppressed

Parameters:

suppressEmptyRows -

toJson

public java.lang.String toJson()
                        throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

close

public void close()

Release memory from collections