org.gytheio.content

Class AbstractContentWorker

java.lang.Object

org.gytheio.content.AbstractContentWorker

All Implemented Interfaces:

ContentWorker

public abstract class AbstractContentWorker
extends Object
implements ContentWorker

Base implementation of a content worker with a sourceContentReferenceHandler field.

Author:

Ray Gauss II

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FRAMEWORK_PROPERTY_NAME
protected static String	FRAMEWORK_PROPERTY_VERSION
protected ContentReferenceHandler	sourceContentReferenceHandler
protected String	versionDetailsString
protected String	versionString

Constructor Summary

Constructors

Constructor and Description
AbstractContentWorker()

Method Summary

Methods

Modifier and Type	Method and Description
protected Properties	getProperties()
String	getVersionDetailsString() Gets a string returning detailed version information such as JVM or command line application's version output
String	getVersionString() Gets a string returning name and version information.
void	initialize() Performs any initialization needed after content reference handlers are set
protected void	initializeVersionDetailsString()
protected void	initializeVersionString()
boolean	isAvailable() Gets whether or not the dependencies of the worker have been properly configured for its normal operation, i.e.
protected void	loadProperties()
protected void	setIsAvailable(boolean isAvailable)
void	setSourceContentReferenceHandler(ContentReferenceHandler sourceContentReferenceHandler) Sets the content reference handler to be used for retrieving the source content to be worked on.

Methods inherited from class java.lang.Object

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

Field Detail

FRAMEWORK_PROPERTY_NAME

protected static final String FRAMEWORK_PROPERTY_NAME

See Also:

Constant Field Values

FRAMEWORK_PROPERTY_VERSION

protected static final String FRAMEWORK_PROPERTY_VERSION

See Also:

Constant Field Values

sourceContentReferenceHandler

protected ContentReferenceHandler sourceContentReferenceHandler

versionString

protected String versionString

versionDetailsString

protected String versionDetailsString

Constructor Detail

AbstractContentWorker

public AbstractContentWorker()

Method Detail

setSourceContentReferenceHandler

public void setSourceContentReferenceHandler(ContentReferenceHandler sourceContentReferenceHandler)

Sets the content reference handler to be used for retrieving the source content to be worked on.

Parameters:

sourceContentReferenceHandler -

initialize

public void initialize()

Performs any initialization needed after content reference handlers are set

isAvailable

public boolean isAvailable()

Description copied from interface: ContentWorker

Gets whether or not the dependencies of the worker have been properly configured for its normal operation, i.e. content reference handlers, command line applications, etc.

Specified by:

isAvailable in interface ContentWorker

Returns:

true if the worker is available

setIsAvailable

protected void setIsAvailable(boolean isAvailable)

getProperties

protected Properties getProperties()

loadProperties

protected void loadProperties()

initializeVersionString

protected void initializeVersionString()

getVersionString

public String getVersionString()

Description copied from interface: ContentWorker

Gets a string returning name and version information.

Specified by:

getVersionString in interface ContentWorker

Returns:

the version string

initializeVersionDetailsString

protected void initializeVersionDetailsString()

getVersionDetailsString

public String getVersionDetailsString()

Description copied from interface: ContentWorker

Gets a string returning detailed version information such as JVM or command line application's version output

Specified by:

getVersionDetailsString in interface ContentWorker

Returns:

the version string