Package org.faceless.publisher

Class Report

java.lang.Object

org.faceless.publisher.Report

public class Report
extends Object

Represents a single Report, as created by ReportFactory.createReport(). At it's simplest the process of creating a Report looks like this:

 ReportFactory factory = ReportFactory.getInstance();
 // configure factory as appropriate
 Report report = factory.createReport();
 report.setReportOutput(output);      // where do you want to send the report?
 // other report configurations as required
 report.load(...);
 report.parse();
 

The various "load" methods can be used to parse the Report from a File or URL, both of which will first configure the report with appropriate settings for that content type (by adding styleshets, setting properties etc). Alternatively, load(InputSource) can be used if you want to configure the Report manually.

After the "load" method, the parse() method is called to read from the input and write the generated Report to the specified ReportOutput.

Alternatively, the ContentHandler, XMLReader and InputSourec can all be retrieved from this object if the parse is to be run externally.

Method Summary

Modifier and Type	Method	Description
void	addReportEventListener(ReportEventListener listener)	Add a listener for one or more events fired on the Report during the parse.
void	fireReportEvent(ReportEvent event)	Fire a ReportEvent.
CallbackHandler	getCallbackHandler()	Return the CallbackHandler, as set by setCallbackHandler(javax.security.auth.callback.CallbackHandler)
ContentHandler	getContentHandler()	Return the ContentHandler which will be used to parse.
EgressFilter	getEgressFilter()	Return the egress filter set by setEgressFilter(org.faceless.publisher.type.EgressFilter)
Map<String,Object>	getEnvironment()	Get a map of environment properties that will be set on this Report.
InputSource	getInputSource()	Return the InputSource which was set by the load(java.lang.Object) method
MediaType	getMediaType()	Return the Media-Type as set by setMediaType(), or as determined automatically by the parser.
List<ProcessingInstruction>	getProcessingInstructions()	Return the list of processing instructions to be inserted before the start element of the document.
ReportFactory	getReportFactory()	Return the ReportFactory this Report was created from
ReportOutput	getReportOutput()	Return the ReportOutput, as set by setReportOutput(org.faceless.publisher.output.ReportOutput)
Blob	getResource(URL2 uri)	Retrieve a Resource as it would be seen by this Report.
URL2	getURL()	Return the URL as set by setURL(org.faceless.publisher.type.URL2)
List<URLConnectionFactory>	getURLConnectionFactories()	Return the list of URLConnectionFactory object which will be used by this Report before the standard ones set on the ReportFactory.getURLConnectionFactories() are checked.
List<URL2>	getUserAgentStylesheets()	Return the list of "user-agent" Stylesheets to add to this Report.
List<URL2>	getUserStylesheets()	Return the list of "user" Stylesheets to add to this Report.
XMLReader	getXMLReader()	Return the XMLReader that will be used by the parse() method.
void	load(Object o)	Load the input from the specified object.
void	parse()	Parse the content loaded with load(java.lang.Object).
void	removeReportEventListener(ReportEventListener listener)	Remove a previously added listener
void	setCallbackHandler(CallbackHandler handler)	Set the CallbackHandler which will be used for authentication by this Reports.
void	setContentHandler(ContentHandler handler)	Override the ContentHandler that will be used to parse.
void	setEgressFilter(EgressFilter filter)	Set the EgressFilter to use for resources loaded by this Document.
void	setMediaType(MediaType mediaType)	Set the Media-Type of the content.
void	setReferrerPolicy(ReferrerPolicy referrerPolicy)	Set the "Referrer Policy" for the document.
void	setReportOutput(ReportOutput output)	Set the ReportOutput to render the Report to
void	setURL(URL2 uri)	Set the URL which this Report will be loaded from in load(java.lang.Object).
void	setXMLReader(SAXParser saxParser)	Set the XMLReader to use when parsing the input set by load(java.lang.Object).
void	setXMLReader(XMLReader xmlReader)	Set the XMLReader to use when parsing the input set by load(java.lang.Object).

Methods inherited from class java.lang.Object

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

Method Details

getReportFactory

public ReportFactory getReportFactory()

Return the ReportFactory this Report was created from

setReportOutput

public void setReportOutput(ReportOutput output)

Set the ReportOutput to render the Report to

getReportOutput

public ReportOutput getReportOutput()

Return the ReportOutput, as set by setReportOutput(org.faceless.publisher.output.ReportOutput)

setReferrerPolicy

public void setReferrerPolicy(ReferrerPolicy referrerPolicy)

Set the "Referrer Policy" for the document. See ReferrerPolicy for details.

getEnvironment

public Map<String,Object> getEnvironment()

Get a map of environment properties that will be set on this Report. The map can be modified.

See Also:

• ReportFactory.getEnvironment()

addReportEventListener

public void addReportEventListener(ReportEventListener listener)

Add a listener for one or more events fired on the Report during the parse. Listeners should have one or more methods that are annotated with the ReportEventListener annotation.

removeReportEventListener

public void removeReportEventListener(ReportEventListener listener)

Remove a previously added listener

fireReportEvent

public void fireReportEvent(ReportEvent event)

Fire a ReportEvent. This is called internally by the parse process, but may be called directly as well.

getUserAgentStylesheets

public List<URL2> getUserAgentStylesheets()

Return the list of "user-agent" Stylesheets to add to this Report. The list can be modified

See Also:

• ReportFactory.getUserAgentStylesheets()

getUserStylesheets

public List<URL2> getUserStylesheets()

Return the list of "user" Stylesheets to add to this Report. The list can be modified

See Also:

• ReportFactory.getUserStylesheets()

getProcessingInstructions

public List<ProcessingInstruction> getProcessingInstructions()

Return the list of processing instructions to be inserted before the start element of the document. This list may be modified.

See Also:

• ContentHandler.processingInstruction(java.lang.String, java.lang.String)

getURLConnectionFactories

public List<URLConnectionFactory> getURLConnectionFactories()

Return the list of URLConnectionFactory object which will be used by this Report before the standard ones set on the ReportFactory.getURLConnectionFactories() are checked. The list is initially empty, but can be modified to add a loader for resources specific to this Report - for example, to load from a particular Zip file, or to include login information specific to this report. The first item this list will be checked first.

See Also:

• ReportFactory.getURLConnectionFactories()

getCallbackHandler

public CallbackHandler getCallbackHandler()

Return the CallbackHandler, as set by setCallbackHandler(javax.security.auth.callback.CallbackHandler)

Returns:

the CallbackHandler to use, which may be null

See Also:

• setCallbackHandler(javax.security.auth.callback.CallbackHandler)

setCallbackHandler

public void setCallbackHandler(CallbackHandler handler)

Set the CallbackHandler which will be used for authentication by this Reports. The default is null. The exact callbacks will depend on the type of authorization required but may include regular NameCallback and PasswordCallback for access to HTTP resources protected by Basic, Digest or AWS4 authentication, for access to KeyStores or (if configured) IMAP Mail Servers. It may also include OAuth2Callback callbacks if OAuth2 authentication is configured for access to HTTP or IMAP resources

Parameters:

handler - the handler, which may be null

See Also:

• OAuth2
• AWS4AuthenticationURLConnectionProcessor
• OAuth2AuthenticationURLConnectionProcessor
• PasswordAuthenticationURLConnectionProcessor

setMediaType

public void setMediaType(MediaType mediaType)

Set the Media-Type of the content. This value will be overriden by the Content-Type header retrieved from the URL if set (which will only apply for HTTP and HTTPS).

Parameters:

mediaType - the MediaType

getMediaType

public MediaType getMediaType()

Return the Media-Type as set by setMediaType(), or as determined automatically by the parser. May be WILDCARD but will never be null.

Returns:

the MediaType

setURL

public void setURL(URL2 uri)

Set the URL which this Report will be loaded from in load(java.lang.Object). This doesn't do anything except make a note of the URL; no connection to the URL is made, and the URL itself is not used unless the object passed to load(java.lang.Object) has no inherent URL of its own. For example, calling this before load(InputStream) will cause any relative URLs within the InputStream to be resolved against this one. But calling this before load(URL2) will have no effect, as the URL2 passed to load() will take precedence.

Parameters:

uri - the URL

getURL

public URL2 getURL()

Return the URL as set by setURL(org.faceless.publisher.type.URL2)

Returns:

the uri

setXMLReader

public void setXMLReader(XMLReader xmlReader)

Set the XMLReader to use when parsing the input set by load(java.lang.Object). If null, the default is used.

Parameters:

xmlReader - the XMLReader

setXMLReader

public void setXMLReader(SAXParser saxParser)
                  throws SAXException

Set the XMLReader to use when parsing the input set by load(java.lang.Object). Simply calls setXMLReader(saxparser.getXMLReader())

Parameters:

saxParser - the SAXParser to retrieve the XMLReader from

Throws:

SAXException

getXMLReader

public XMLReader getXMLReader()
                       throws SAXException,
ParserConfigurationException

Return the XMLReader that will be used by the parse() method. If this was set by setXMLReader(org.xml.sax.XMLReader) it will use that value, otherwise it will call ReportFactory.newXMLReader(org.faceless.publisher.type.MediaType, java.util.Map<java.lang.String, java.lang.Object>)

Returns:

the XMLReader

Throws:

SAXException

ParserConfigurationException

setContentHandler

public void setContentHandler(ContentHandler handler)

Override the ContentHandler that will be used to parse. This method should be used only to set a filter on the existing ContentHandler if required; replacing the existing ContentHandler completely will result in the Report not being generated.

Note that if the supplied handler also impements DTDHandler, ErrorHandler, or EntityResolver, those interfaces will be applied before parsing.

Parameters:

handler - the ContentHandler to receive the parsing events

getContentHandler

public ContentHandler getContentHandler()

Return the ContentHandler which will be used to parse. This is set internally to the entry-point for the parsing process, although it can be overridden with setContentHandler(org.xml.sax.ContentHandler)

Returns:

the contentHandler

load

public void load(Object o)
          throws IOException

Load the input from the specified object. Example object that can be passed in to this method include.

• InputSource
• URL
• URI
• URLConnection
• URL2
• InputStream
• Reader
• byte[]
• File
• Path
• CharSequence/String (will be parsed as a File if it exists, URL if possible or a UTF-8 byte stream otherwise)
• javax.mail.internet.MimeMessage

If the supplied object is an InputSource it will be processed directly. Otherwise the object will be converted to a URLConnection, and if headers are available the MediaType will be determined from the "Content-Type" header if set, falling back to the setMediaType(org.faceless.publisher.type.MediaType) if that is set and finally the type sniffed from the file contents and/or filename. An appropriate ReportConfiguration will then be applied to this Report, and the configuration should then load an appropriate InputSource.

Parameters:

o - the object to load

Throws:

IOException - if an exception is received when loading the source document

IllegalArgumentException - if the object cannot be parsed

getInputSource

public InputSource getInputSource()

Return the InputSource which was set by the load(java.lang.Object) method

setEgressFilter

public void setEgressFilter(EgressFilter filter)

Set the EgressFilter to use for resources loaded by this Document. If not set when the the load(java.lang.Object) method is called, it will automatically set the filter to a EgressFilter.DEFAULT based on the System ID of the InputSource, which should be set (if possible) to the absolute URL of the source document.

Parameters:

filter - the egress filter to use, or null to use the default.

getEgressFilter

public EgressFilter getEgressFilter()

Return the egress filter set by setEgressFilter(org.faceless.publisher.type.EgressFilter)

parse

public void parse()
           throws IOException,
SAXException,
ParserConfigurationException

Parse the content loaded with load(java.lang.Object). This will set the ContentHandler (and, if applicable, DTDHandler, EntityResolver and ErrorHandler) on the XMLReader returned by getXMLReader(), then call xmlreader.parse(getInputSource()). Call this method after load().

Throws:

IOException

SAXException

ParserConfigurationException

getResource

public Blob getResource(URL2 uri)

Retrieve a Resource as it would be seen by this Report. Can be used to extract the generated index by passing in "about:index", a generated stylesheet (eg "fonts:C:/Windows/Fonts") or any external resource to verify it's loading properly.

Parameters:

uri - the URL of the Document to retrieve: typically "about:index";

Returns:

an InputSource, or null if none exists.