Package org.opennms.systemreport.formatters

Class AbstractSystemReportFormatter

java.lang.Object

org.opennms.systemreport.formatters.AbstractSystemReportFormatter

All Implemented Interfaces:

java.lang.Comparable<SystemReportFormatter>, SystemReportFormatter

Direct Known Subclasses:

FtpSystemReportFormatter, FullTextSystemReportFormatter, TextSystemReportFormatter, XmlSystemReportFormatter, ZipSystemReportFormatter

public abstract class AbstractSystemReportFormatter
extends java.lang.Object
implements SystemReportFormatter

Field Summary

Fields

Modifier and Type	Field	Description
protected java.io.OutputStream	m_outputStream

Constructor Summary

Constructors

Constructor	Description
AbstractSystemReportFormatter()

Method Summary

Modifier and Type	Method	Description
void	begin()	Indicates that report output will begin.
int	compareTo(SystemReportFormatter o)
void	end()	Indicates that report output will end.
java.lang.String	getDescription()	A short description of the format.
java.lang.String	getName()	A short name for this format for use by UIs when presenting an option of which formatter to choose.
protected java.lang.String	getOutput()
protected java.io.OutputStream	getOutputStream()
protected java.lang.String	getResourceText(org.springframework.core.io.Resource r)
protected boolean	hasDisplayable(SystemReportPlugin plugin)
protected boolean	isDisplayable(org.springframework.core.io.Resource r)
protected boolean	isFile(org.springframework.core.io.Resource r)
boolean	needsOutputStream()	Whether or not this formatter needs to be given an output stream.
void	setOutput(java.lang.String output)	The output string as passed on the command-line.
void	setOutputStream(java.io.OutputStream stream)	The output stream to use when writing data.
void	write(SystemReportPlugin plugin)	Write the data from the specified SystemReportPlugin.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.systemreport.SystemReportFormatter

canStdout, getContentType, getExtension

Field Detail

m_outputStream

protected java.io.OutputStream m_outputStream

Constructor Detail

AbstractSystemReportFormatter

public AbstractSystemReportFormatter()

Method Detail

getOutput

protected java.lang.String getOutput()

setOutput

public void setOutput(java.lang.String output)

Description copied from interface: SystemReportFormatter

The output string as passed on the command-line.

Specified by:

setOutput in interface SystemReportFormatter

getOutputStream

protected java.io.OutputStream getOutputStream()

setOutputStream

public void setOutputStream(java.io.OutputStream stream)

Description copied from interface: SystemReportFormatter

The output stream to use when writing data.

Specified by:

setOutputStream in interface SystemReportFormatter

needsOutputStream

public boolean needsOutputStream()

Description copied from interface: SystemReportFormatter

Whether or not this formatter needs to be given an output stream.

Specified by:

needsOutputStream in interface SystemReportFormatter

getName

public java.lang.String getName()

Description copied from interface: SystemReportFormatter

A short name for this format for use by UIs when presenting an option of which formatter to choose.

Specified by:

getName in interface SystemReportFormatter

Returns:

the format name (eg, "text", "xml", etc.)

getDescription

public java.lang.String getDescription()

Description copied from interface: SystemReportFormatter

A short description of the format.

Specified by:

getDescription in interface SystemReportFormatter

Returns:

the description

write

public void write(SystemReportPlugin plugin)

Description copied from interface: SystemReportFormatter

Write the data from the specified SystemReportPlugin.

Specified by:

write in interface SystemReportFormatter

Parameters:

plugin - the system report plugin which contains the data to write

begin

public void begin()

Description copied from interface: SystemReportFormatter

Indicates that report output will begin.

Specified by:

begin in interface SystemReportFormatter

end

public void end()

Description copied from interface: SystemReportFormatter

Indicates that report output will end.

Specified by:

end in interface SystemReportFormatter

compareTo

public final int compareTo(SystemReportFormatter o)

Specified by:

compareTo in interface java.lang.Comparable<SystemReportFormatter>

isDisplayable

protected boolean isDisplayable(org.springframework.core.io.Resource r)

isFile

protected boolean isFile(org.springframework.core.io.Resource r)

getResourceText

protected java.lang.String getResourceText(org.springframework.core.io.Resource r)

hasDisplayable

protected boolean hasDisplayable(SystemReportPlugin plugin)