Package com.ptc.tml.log

Class TmlLog

java.lang.Object

com.ptc.tml.log.TmlLog

All Implemented Interfaces:

Externalizable, Serializable, Evolvable

Direct Known Subclasses:

TmlImportLog, TmlPackageLog

public abstract class TmlLog
extends Object
implements Serializable, Evolvable

Supported API: true Serializable class to follow translation process through workflow, collecting logging information

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
TmlPackageLog	addCollection(TranslationCollection collection)	Supported API: true Adds collection information to a log
void	addError(String message, Throwable exception)	Supported API: true Adds a generic error to the log; this message ought to be localized
void	addErrorNoDocsToTranslate()	Supported API: true Adds a 'No documents to translate' error to the log
String	getImportFailureNotificationSubject()	Supported API: true Return localized import failure notification subject message.
String	getImportSuccessNotificationSubject()	Supported API: true Return localized import successfull notification subject message.
String	getWarningNotificationSubject()	Supported API: true Return localized warning notification subject message.
int	numErrors()	Supported API: true The number of errors in encountered so far
void	resetErrors()	Supported API: true Clears the errors from the log; only to be used once the errors have already been written.
StringBuilder	toHtmlSummaryString()	Supported API: true Gets a summary string formatted in HTML.
StringBuilder	toHtmlWarningString()	Supported API: true Gets a summary string formatted in HTML.

Methods inherited from class java.lang.Object

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

Method Details

numErrors

public int numErrors()

Supported API: true The number of errors in encountered so far

addErrorNoDocsToTranslate

public void addErrorNoDocsToTranslate()

Supported API: true Adds a 'No documents to translate' error to the log

addError

public void addError(String message,
 Throwable exception)

Supported API: true Adds a generic error to the log; this message ought to be localized

resetErrors

public void resetErrors()

Supported API: true Clears the errors from the log; only to be used once the errors have already been written.

addCollection

public TmlPackageLog addCollection(TranslationCollection collection)
                            throws TranslationException

Supported API: true Adds collection information to a log

Throws:

TranslationException

toHtmlSummaryString

public StringBuilder toHtmlSummaryString()
                                  throws TranslationException

Supported API: true Gets a summary string formatted in HTML. Includes info on warnings, documents and errors

Throws:

TranslationException

toHtmlWarningString

public StringBuilder toHtmlWarningString()
                                  throws TranslationException

Supported API: true Gets a summary string formatted in HTML. Includes info on warnings and errors

Throws:

TranslationException

getWarningNotificationSubject

public String getWarningNotificationSubject()

Supported API: true Return localized warning notification subject message.

getImportSuccessNotificationSubject

public String getImportSuccessNotificationSubject()

Supported API: true Return localized import successfull notification subject message.

getImportFailureNotificationSubject

public String getImportFailureNotificationSubject()

Supported API: true Return localized import failure notification subject message.