org.inria.ns.reflex.modules.io
Class CreateDirAction

java.lang.Object
  extended by org.inria.ns.reflex.processor.core.AbstractAction
      extended by org.inria.ns.reflex.processor.core.AbstractSetAction
          extended by org.inria.ns.reflex.modules.io.CreateDirAction
All Implemented Interfaces:
Computable, Executable, Presentable, NamespaceContextFactory

public class CreateDirAction
extends AbstractSetAction

At runtime, the <io:create-dir> element creates a directory whose name is specified in the uri attribute.

A new property with the name specified in the name attribute handles the directory created, and is added to the data set.

 <io:create-dir name="myNewDir" uri="{ expression }"
 xmlns:io="http://ns.inria.org/active-tags/io"/>
 
 <io:create-dir name="myNewDir" uri="{ expression }"
   path="{ expression }"
 xmlns:io="http://ns.inria.org/active-tags/io"/>
 

Author:
Philippe Poulard

Nested Class Summary
 
Nested classes/interfaces inherited from class org.inria.ns.reflex.processor.core.AbstractAction
AbstractAction.ParameterAdapter, AbstractAction.UselessAction
 
Field Summary
 
Fields inherited from class org.inria.ns.reflex.processor.core.AbstractSetAction
NO_VALUE
 
Fields inherited from class org.inria.ns.reflex.processor.core.AbstractAction
actions, parent, processorInstance
 
Constructor Summary
CreateDirAction(Expression dirname, Expression path, Element element, AbstractAction parent)
          Create a new instance of CreateDirAction.
 
Method Summary
 Object getComputedValue(DataSet dataSet)
          Return the computed value of the property, by creating a directory.
static AbstractAction unmarshal(AbstractAction parent, Element element)
          XML unmarshaller for CreateDirAction.
 
Methods inherited from class org.inria.ns.reflex.processor.core.AbstractSetAction
addProperty, getComputedName, getName, getValue, runAction, scope, unmarshalScope
 
Methods inherited from class org.inria.ns.reflex.processor.core.AbstractAction
addAction, addFallbackAction, createContext, getCanonicalPath, getFallbackAction, getLocalFallbackAction, getLogger, getNamespaceContext, getNode, getParent, recover, recover, removeFallbackAction, reorganize, run, runActions, toPrettyString, toPrettyString, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CreateDirAction

public CreateDirAction(Expression dirname,
                       Expression path,
                       Element element,
                       AbstractAction parent)
                throws XMLException
Create a new instance of CreateDirAction.

Parameters:
dirname - The name of the directory to create, that will be the value of the property, as an Expression ; or the name of the base directory if the path is not null.
path - The path relative to the base directory, or null.
element - The element from which the action has been unmarshalled. Used for namespace prefix resolution when performing XPath expressions.
parent - The action depending from.
Throws:
XMLException
Method Detail

unmarshal

public static AbstractAction unmarshal(AbstractAction parent,
                                       Element element)
                                throws XMLException
XML unmarshaller for CreateDirAction.

Parameters:
parent - The action depending from
element - The XML element to unmarshall.
Returns:
The CreateDirAction created.
Throws:
UnmarshalException - When the element and its content is not those expected.
XMLException

getComputedValue

public Object getComputedValue(DataSet dataSet)
                        throws ExecutionException,
                               XPathException
Return the computed value of the property, by creating a directory.

Specified by:
getComputedValue in interface Computable
Specified by:
getComputedValue in class AbstractSetAction
Parameters:
dataSet - The set of data used when the name is computed.
Returns:
The computed value of the property.
Throws:
ExecutionException - If the computation can't be performed.
XPathException