org.writersforge.catalan.process.workers.xml
Class XmlCommonProperties

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.xml.XmlCommonProperties

All Implemented Interfaces:

IWorkProperties

public class XmlCommonProperties

extends CommonProperties

Specialized properties container for XmlWorker.

Author:

jsheets

Constructor Summary

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

Method Summary

java.lang.String	getAttribute() Retrieves the value of the "attribute" property.
java.lang.String	getAttributeValue() Retrieves the value of the "attribute-value" property.
boolean	getCollapse() Retrieves the value of the "collapse" property.
org.writersforge.bellows.Datum	getContent() Retrieves the value of the "content" property.
java.lang.String	getDestination() Retrieves the value of the "dest" property.
boolean	getExpand() Retrieves the value of the "expand" property.
boolean	getKeepOriginal() Retrieves the value of the "keep-original" property.
boolean	getMakeCopy() Retrieves the value of the "make-copy" property.
java.lang.String	getNewName() Retrieves the value of the "new-name" property.
java.lang.String[]	getPaths() Retrieves the value of the "paths" property.
int	getPosition() Retrieves the value of the "position" property.
org.writersforge.bellows.Datum[]	getQueries() Retrieves the value of the "queries" property.
java.lang.String	getQuery() Retrieves the value of the "query" property.
java.lang.String	getSeparator() Retrieves the value of the "separator" property.
DirectiveStack	getStack() Retrieves the value of the "stack" property.
int	getStartTagIndex() Retrieves the value of the "start-tag-index" property.
org.writersforge.bellows.util.PropertyName.PropertyStyle	getStyle() Retrieves the value of the "style" property.
java.lang.String	getTagAttribute() Retrieves the value of the "attribute" property for the "tag" command.
java.lang.String	getWrapper() Retrieves the value of the "wrapper" 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

XmlCommonProperties

public XmlCommonProperties(IWorkProperties baseProps)

Creates a new instance of XmlCommonProperties.

Parameters:

baseProps - properties to wrap

Method Detail

getQuery

public java.lang.String getQuery()

Retrieves the value of the "query" property.

Returns:

the "query" property

getDestination

public java.lang.String getDestination()

Retrieves the value of the "dest" property.

Returns:

the "dest" property

getKeepOriginal

public boolean getKeepOriginal()

Retrieves the value of the "keep-original" property. Defaults to "true", for copy semantics.

Returns:

the "keep-original" property

getMakeCopy

public boolean getMakeCopy()

Retrieves the value of the "make-copy" property. Defaults to "true", for copy semantics.

Returns:

the "make-copy" property

getAttribute

public java.lang.String getAttribute()

Retrieves the value of the "attribute" property.

Returns:

the "attribute" property

getAttributeValue

public java.lang.String getAttributeValue()

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

Returns:

the "attribute-value" property

getTagAttribute

public java.lang.String getTagAttribute()

Retrieves the value of the "attribute" property for the "tag" command. Defaults to "number".

Returns:

the "attribute" property

getNewName

public java.lang.String getNewName()

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

Returns:

the "new-name" property

getPosition

public int getPosition()

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

Returns:

the "position" property

getWrapper

public java.lang.String getWrapper()

Retrieves the value of the "wrapper" property.

Returns:

the "wrapper" property

getSeparator

public java.lang.String getSeparator()

Retrieves the value of the "separator" property.

Returns:

the "separator" property

getStartTagIndex

public int getStartTagIndex()

Retrieves the value of the "start-tag-index" property.

Returns:

the "start-tag-index" property

getPaths

public java.lang.String[] getPaths()

Retrieves the value of the "paths" property.

Returns:

the "paths" property

getContent

public org.writersforge.bellows.Datum getContent()

Retrieves the value of the "content" property.

Returns:

the "content" property

getCollapse

public boolean getCollapse()

Retrieves the value of the "collapse" property.

Returns:

the "collapse" property

getExpand

public boolean getExpand()

Retrieves the value of the "expand" property.

Returns:

the "expand" property

getStyle

public org.writersforge.bellows.util.PropertyName.PropertyStyle getStyle()

Retrieves the value of the "style" property.

Returns:

the "style" property

getQueries

public org.writersforge.bellows.Datum[] getQueries()

Retrieves the value of the "queries" property.

Returns:

the "queries" property

getStack

public DirectiveStack getStack()

Retrieves the value of the "stack" property.

Returns:

the "stack" property