org.opencms.report

类 A_CmsReport

java.lang.Object

org.opencms.report.A_CmsReport

所有已实现的接口:

I_CmsReport

直接已知子类:

CmsHtmlReport, CmsLogReport, CmsMultiplexReport, CmsStringBufferReport

public abstract class A_CmsReport
extends java.lang.Object
implements I_CmsReport

Base report class.

从以下版本开始:

6.0.0

字段概要

从接口继承的字段 org.opencms.report.I_CmsReport

FORMAT_DEFAULT, FORMAT_ERROR, FORMAT_HEADLINE, FORMAT_NOTE, FORMAT_OK, FORMAT_WARNING, REPORT_TYPE_EXTENDED, REPORT_TYPE_SIMPLE

构造器概要

构造器

构造器和说明
A_CmsReport()

方法概要

方法

限定符和类型	方法和说明
void	addError(java.lang.Object obj) Adds an error object to the list of errors that occurred during the report.
void	addWarning(java.lang.Object obj) Adds a warning object to the list of warnings that occurred during the report.
java.lang.String	formatRuntime() Formats the runtime formatted as "hh:mm:ss".
java.util.List<java.lang.Object>	getErrors() Returns a list of all errors that occurred during the report.
long	getLastEntryTime() Returns the time of last report entry.
java.util.Locale	getLocale() Returns the locale this report was initialized with.
protected CmsMessages	getMessages() Returns the default report message bundle.
long	getRuntime() Returns the time this report has been running.
java.lang.String	getSiteRoot() Returns the original site root of the user who started this report, or null if the original site root has not been set.
java.util.List<java.lang.Object>	getWarnings() Returns a list of all warnings that occurred during the report.
boolean	hasError() Returns if the report generated an error output.
boolean	hasWarning() Returns if the report generated a warning output.
protected void	init(java.util.Locale locale, java.lang.String siteRoot) Initializes some member variables for this report.
void	print(CmsMessageContainer container) Prints a localized message to the report.
void	print(CmsMessageContainer container, int format) Prints a localized message to the report, using the indicated formatting.
protected void	print(java.lang.String value) Prints a String to the report.
protected abstract void	print(java.lang.String value, int format) Prints a String to the report, using the indicated formatting.
void	println(CmsMessageContainer container) Prints a localized message to the report.
void	println(CmsMessageContainer container, int format) Prints a localized message to the report, using the indicated formatting.
protected void	println(java.lang.String value) Prints a String with line break to the report.
protected void	println(java.lang.String value, int format) Prints a String with line break to the report, using the indicated formatting.
void	printMessageWithParam(CmsMessageContainer container, java.lang.Object param) Prints a localized message followed by a parametera and dots to the report.
void	printMessageWithParam(int m, int n, CmsMessageContainer container, java.lang.Object param) Convenience method to print a localized message, followed by a parameter and dots to the report.
java.lang.String	removeSiteRoot(java.lang.String resourcename) Removes the report site root prefix from the absolute path in the resource name, that is adjusts the resource name for the report site root.
void	resetRuntime() Resets the runtime to 0 milliseconds.
protected void	setLastEntryTime(long time) Sets the time of the last report entry.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.report.I_CmsReport

getReportUpdate, println, println

构造器详细资料

A_CmsReport

public A_CmsReport()

方法详细资料

addError

public void addError(java.lang.Object obj)

从接口复制的说明: I_CmsReport

Adds an error object to the list of errors that occurred during the report.

指定者:

addError 在接口中 I_CmsReport

参数:

obj - the error object

另请参阅:

I_CmsReport.addError(java.lang.Object)

addWarning

public void addWarning(java.lang.Object obj)

从接口复制的说明: I_CmsReport

Adds a warning object to the list of warnings that occurred during the report.

指定者:

addWarning 在接口中 I_CmsReport

参数:

obj - the error object

另请参阅:

I_CmsReport.addWarning(java.lang.Object)

formatRuntime

public java.lang.String formatRuntime()

从接口复制的说明: I_CmsReport

Formats the runtime formatted as "hh:mm:ss".

指定者:

formatRuntime 在接口中 I_CmsReport

返回:

the runtime formatted as "hh:mm:ss"

另请参阅:

I_CmsReport.formatRuntime()

getErrors

public java.util.List<java.lang.Object> getErrors()

从接口复制的说明: I_CmsReport

Returns a list of all errors that occurred during the report.

指定者:

getErrors 在接口中 I_CmsReport

返回:

an error list that occurred during the report

另请参阅:

I_CmsReport.getErrors()

getLastEntryTime

public long getLastEntryTime()

从接口复制的说明: I_CmsReport

Returns the time of last report entry.

Will return zero if no entry has been written.

指定者:

getLastEntryTime 在接口中 I_CmsReport

返回:

time of last report entry

另请参阅:

I_CmsReport.getLastEntryTime()

getLocale

public java.util.Locale getLocale()

从接口复制的说明: I_CmsReport

Returns the locale this report was initialized with.

指定者:

getLocale 在接口中 I_CmsReport

返回:

the locale this report was initialized with

另请参阅:

I_CmsReport.getLocale()

getRuntime

public long getRuntime()

从接口复制的说明: I_CmsReport

Returns the time this report has been running.

指定者:

getRuntime 在接口中 I_CmsReport

返回:

the time this report has been running

另请参阅:

I_CmsReport.getRuntime()

getSiteRoot

public java.lang.String getSiteRoot()

Returns the original site root of the user who started this report, or null if the original site root has not been set.

指定者:

getSiteRoot 在接口中 I_CmsReport

返回:

the original site root of the user who started this report

getWarnings

public java.util.List<java.lang.Object> getWarnings()

从接口复制的说明: I_CmsReport

Returns a list of all warnings that occurred during the report.

指定者:

getWarnings 在接口中 I_CmsReport

返回:

a warning list that occurred during the report

另请参阅:

I_CmsReport.getWarnings()

hasError

public boolean hasError()

从接口复制的说明: I_CmsReport

Returns if the report generated an error output.

指定者:

hasError 在接口中 I_CmsReport

返回:

true if the report generated an error, otherwise false

另请参阅:

I_CmsReport.hasError()

hasWarning

public boolean hasWarning()

从接口复制的说明: I_CmsReport

Returns if the report generated a warning output.

指定者:

hasWarning 在接口中 I_CmsReport

返回:

true if the report generated a warning, otherwise false

另请参阅:

I_CmsReport.hasWarning()

print

public void print(CmsMessageContainer container)

从接口复制的说明: I_CmsReport

Prints a localized message to the report.

指定者:

print 在接口中 I_CmsReport

参数:

container - the String to add

另请参阅:

I_CmsReport.print(org.opencms.i18n.CmsMessageContainer)

print

public void print(CmsMessageContainer container,
         int format)

从接口复制的说明: I_CmsReport

Prints a localized message to the report, using the indicated formatting.

Use the contants starting with FORMAT from this interface to indicate which formatting to use.

指定者:

print 在接口中 I_CmsReport

参数:

container - the String to add

format - the formatting to use for the output

另请参阅:

I_CmsReport.print(org.opencms.i18n.CmsMessageContainer, int)

println

public void println(CmsMessageContainer container)

从接口复制的说明: I_CmsReport

Prints a localized message to the report.

指定者:

println 在接口中 I_CmsReport

参数:

container - the message container to add

另请参阅:

I_CmsReport.println(org.opencms.i18n.CmsMessageContainer)

println

public void println(CmsMessageContainer container,
           int format)

从接口复制的说明: I_CmsReport

Prints a localized message to the report, using the indicated formatting.

Use the contants starting with FORMAT from this interface to indicate which formatting to use.

指定者:

println 在接口中 I_CmsReport

参数:

container - the message container to add

format - the formatting to use for the output

另请参阅:

I_CmsReport.println(org.opencms.i18n.CmsMessageContainer, int)

printMessageWithParam

public void printMessageWithParam(CmsMessageContainer container,
                         java.lang.Object param)

从接口复制的说明: I_CmsReport

Prints a localized message followed by a parametera and dots to the report.

指定者:

printMessageWithParam 在接口中 I_CmsReport

参数:

container - the Message to add

param - the Parameter to add

另请参阅:

I_CmsReport.printMessageWithParam(org.opencms.i18n.CmsMessageContainer,Object)

printMessageWithParam

public void printMessageWithParam(int m,
                         int n,
                         CmsMessageContainer container,
                         java.lang.Object param)

从接口复制的说明: I_CmsReport

Convenience method to print a localized message, followed by a parameter and dots to the report.

The output follows the pattern: ( 3 / 8 ) Deleting filename.txt ...

指定者:

printMessageWithParam 在接口中 I_CmsReport

参数:

m - the number of the report output

n - the total number of report outputs

container - the Message to add

param - the Parameter to add

另请参阅:

I_CmsReport.printMessageWithParam(int,int,org.opencms.i18n.CmsMessageContainer,Object)

removeSiteRoot

public java.lang.String removeSiteRoot(java.lang.String resourcename)

Removes the report site root prefix from the absolute path in the resource name, that is adjusts the resource name for the report site root.

If the site root for this report has not been set, or the resource name does not start with the report site root, the name it is left untouched.

指定者:

removeSiteRoot 在接口中 I_CmsReport

参数:

resourcename - the resource name (full path)

返回:

the resource name adjusted for the report site root

另请参阅:

CmsRequestContext.removeSiteRoot(String)

resetRuntime

public void resetRuntime()

从接口复制的说明: I_CmsReport

Resets the runtime to 0 milliseconds.

指定者:

resetRuntime 在接口中 I_CmsReport

另请参阅:

I_CmsReport.resetRuntime()

getMessages

protected CmsMessages getMessages()

Returns the default report message bundle.

返回:

the default report message bundle

init

protected void init(java.util.Locale locale,
        java.lang.String siteRoot)

Initializes some member variables for this report.

参数:

locale - the locale for this report

siteRoot - the site root of the user who started this report (may be null)

print

protected void print(java.lang.String value)

Prints a String to the report.

参数:

value - the String to add

print

protected abstract void print(java.lang.String value,
         int format)

Prints a String to the report, using the indicated formatting.

Use the constants starting with FORMAT from this interface to indicate which formatting to use.

参数:

value - the message container to add

format - the formatting to use for the output

println

protected void println(java.lang.String value)

Prints a String with line break to the report.

参数:

value - the message container to add

println

protected void println(java.lang.String value,
           int format)

Prints a String with line break to the report, using the indicated formatting.

Use the constants starting with C_FORMAT from this interface to indicate which formatting to use.

参数:

value - the String to add

format - the formatting to use for the output

setLastEntryTime

protected void setLastEntryTime(long time)

Sets the time of the last report entry.

参数:

time - the time of the actual entry