Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

jbreport
Interface Repository  view Repository download Repository.java

All Superinterfaces:
ReportComposite, ReportElement

public interface Repository
extends ReportComposite

This represents a storage area for a bunch of other element types, including but not limited to, datasources, queries, documents, etc.

It should be noted that a repository forms its' own namespace, and that elements such as queries can be obtained by referring to a given namespace. ie. should a Query x be required from Repository y, we can either get Repository y, and then call getQuery("x") on it, or if we already have a Repository z, then the call getQuery("y.x") will return the same Query element.

Version:
$Revision: 1.1.1.1 $

Field Summary
 
Fields inherited from interface jbreport.ReportElement
DEEP, SHALLOW
 
Method Summary
 java.util.Iterator documentNames()
          Returns an iterator over the available document names within this repository, although the caller should check the iterator.hasNext () method is not false on return.
 ReportSection fetchDocument(java.lang.String name)
          Returns the document for the given name, if one exists.
 ReportElement fetchFragment(java.lang.String name)
          Returns the fragment for the given name, if one exists.
 ReportStylesheet fetchStylesheet(java.lang.String name)
          Returns the stylesheet for the given name, if one exists.
 
Methods inherited from interface jbreport.ReportComposite
addElement
 
Methods inherited from interface jbreport.ReportElement
boundParameters, copy, copy, getBoundParamValue, getElement, getFactory, getList, getName, getParent, getRepository, getString, getStylesheet, getType, loadData, setParent, setString, xmlEnd, xmlEndChild, xmlInitialize
 

Method Detail

fetchDocument

public ReportSection fetchDocument(java.lang.String name)
                            throws ReportException
Returns the document for the given name, if one exists. The name can be in a different namespace, in which case the appropriate lookup will be performed by the framework.


documentNames

public java.util.Iterator documentNames()
Returns an iterator over the available document names within this repository, although the caller should check the iterator.hasNext () method is not false on return. This would indicate that there are no defined documents in this repository.

The iterator returned does not support the remove() method.


fetchFragment

public ReportElement fetchFragment(java.lang.String name)
                            throws ReportException
Returns the fragment for the given name, if one exists. The name can be in a different namespace, in which case the appropriate lookup will be performed by the framework.


fetchStylesheet

public ReportStylesheet fetchStylesheet(java.lang.String name)
                                 throws ReportException
Returns the stylesheet for the given name, if one exists. The name can be in a different namespace, in which case the appropriate lookup will be performed by the framework.