databionics.modules
Class OutputFileParameter

java.lang.Object
  databionics.modules.Parameter
      databionics.modules.AbstractStringParameter
          databionics.modules.AbstractFileParameter
              databionics.modules.OutputFileParameter

public class OutputFileParameter
extends AbstractFileParameter

FileParameter for output files.

Field Summary

protected static org.apache.log4j.Logger	log log4j logging
protected java.lang.String	template template for filename

Fields inherited from class databionics.modules.AbstractFileParameter

type

Fields inherited from class databionics.modules.AbstractStringParameter

def, value

Fields inherited from class databionics.modules.Parameter

constant, description, longName, name, optional

Constructor Summary

OutputFileParameter()

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
java.lang.String	generateFileName(Job job) Generate filename based on template and parameters
java.lang.String	getTemplate() Get the filename template
void	setTemplate(java.lang.String t) Set the filename template
void	setValue(java.lang.String var) Set the value.
java.lang.String	toXml() XML representation
static OutputFileParameter	valueOf(org.w3c.dom.Element el) Create a FileParameter from an XML tag

Methods inherited from class databionics.modules.AbstractFileParameter

getType, setType

Methods inherited from class databionics.modules.AbstractStringParameter

getDefault, getValue, getValueAsString, setDefault, toString

Methods inherited from class databionics.modules.Parameter

getDescription, getLongName, getName, isConstant, isOptional, setConstant, setDescription, setLongName, setName, setOptional

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

log4j logging

template

protected java.lang.String template

template for filename

Constructor Detail

OutputFileParameter

public OutputFileParameter()

Method Detail

getTemplate

public java.lang.String getTemplate()

Get the filename template

setTemplate

public void setTemplate(java.lang.String t)

Set the filename template

generateFileName

public java.lang.String generateFileName(Job job)

Generate filename based on template and parameters

setValue

public void setValue(java.lang.String var)

Set the value.

Overrides:

setValue in class AbstractStringParameter

Parameters:

var - the path of the file

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Specified by:

clone in class Parameter

valueOf

public static OutputFileParameter valueOf(org.w3c.dom.Element el)

Create a FileParameter from an XML tag

toXml

public java.lang.String toXml()

XML representation

Specified by:

toXml in class Parameter