org.writersforge.catalan.process.workers.queue
Class QueueProperties

java.lang.Object
  org.writersforge.catalan.process.properties.BaseWorkProperties
      org.writersforge.catalan.process.properties.ChainedProperties
          org.writersforge.catalan.process.properties.CommonProperties
              org.writersforge.catalan.process.workers.queue.QueueProperties

All Implemented Interfaces:

IWorkProperties

public class QueueProperties

extends CommonProperties

Specialized properties container for QueueWorker and QueueNodeWorker.

Author:

jsheets

Constructor Summary

QueueProperties(IWorkProperties baseProps)
Creates a new instance of QueueProperties.

Method Summary

boolean	getAbortOnFail() Retrieves the value of the "abort-on-fail" property.
boolean	getBeforeNode() Retrieves the value of the "before-node" property.
java.lang.Object	getContent() Retrieves the value of the "content" property.
java.lang.String	getConvertType() Retrieves the value of the "convert-type" property.
java.lang.String	getDateFormat() Retrieves the value of the "date-format" property.
java.lang.String	getDestQueue() Retrieves the value of the "dest-queue" property.
NodeSelection	getNodeSelection() Retrieves the value of the "nodes" property.
int	getPosition() Retrieves the value of the "pos" property.
int	getPosition(int nodeCount) Retrieves the value of the "pos" property, as a real queue index.
java.lang.String	getPropertyName() Retrieves the value of the "property-name" property.
java.lang.String	getQueue() Retrieves the value of the "queue" property.

Methods inherited from class org.writersforge.catalan.process.properties.CommonProperties

getCommand, getCount, getEndIndex, getStartIndex

Methods inherited from class org.writersforge.catalan.process.properties.ChainedProperties

addPropertySet, getProperty, getPropertyNames, getPropertySets, toString

Methods inherited from class org.writersforge.catalan.process.properties.BaseWorkProperties

asMap, asMap, getPropertyAsBoolean, getPropertyAsDatum, getPropertyAsMap, getPropertyAsNumber, getPropertyAsString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.writersforge.catalan.process.properties.IWorkProperties

getProperty, getPropertyAsBoolean, getPropertyAsDatum, getPropertyAsMap, getPropertyAsNumber, getPropertyAsString, getPropertyNames

Constructor Detail

QueueProperties

public QueueProperties(IWorkProperties baseProps)

Creates a new instance of QueueProperties.

Parameters:

baseProps - properties to wrap

Method Detail

getQueue

public java.lang.String getQueue()

Retrieves the value of the "queue" property. Default to "default".

Returns:

the "queue" property

getDestQueue

public java.lang.String getDestQueue()

Retrieves the value of the "dest-queue" property.

Returns:

the "dest-queue" property

getPosition

public int getPosition()

Retrieves the value of the "pos" property. Defaults to -1.

Returns:

the "pos" property

getPosition

public int getPosition(int nodeCount)

Retrieves the value of the "pos" property, as a real queue index. Converts negative indexes into positive indexes.

Parameters:

nodeCount - number of nodes in the queue

Returns:

the "pos" property

getNodeSelection

public NodeSelection getNodeSelection()

Retrieves the value of the "nodes" property.

Returns:

the "nodes" property

getContent

public java.lang.Object getContent()

Retrieves the value of the "content" property.

Returns:

the "content" property

getBeforeNode

public boolean getBeforeNode()

Retrieves the value of the "before-node" property. Defaults to false.

Returns:

the "before-node" property

getPropertyName

public java.lang.String getPropertyName()

Retrieves the value of the "property-name" property.

Returns:

the "property-name" property

getConvertType

public java.lang.String getConvertType()

Retrieves the value of the "convert-type" property. Defaults to "string".

Returns:

the "convert-type" property

getAbortOnFail

public boolean getAbortOnFail()

Retrieves the value of the "abort-on-fail" property. Defaults to false.

Returns:

the "abort-on-fail" property

getDateFormat

public java.lang.String getDateFormat()

Retrieves the value of the "date-format" property. Defaults to "yyyyMMdd".

Returns:

the "date-format" property