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

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.FileAction
All Implemented Interfaces:
Computable, Executable, Presentable, NamespaceContextFactory

public class FileAction
extends AbstractSetAction

At runtime, the <io:file> element represent a file specified by the uri attribute.

A new property with the name specified in the name attribute holds the file, and is added to the data set.

 <io:file name="MyFile" uri="{ 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
FileAction(Expression uri, EvaluableExpression mimeType, EvaluableExpression encoding, Element element, AbstractAction parent)
          Create a new instance of FileAction.
 
Method Summary
 Object getComputedValue(DataSet dataSet)
          Return the computed value of the property, an XFile object.
static AbstractAction unmarshal(AbstractAction parent, Element element)
          Unmarshaller for FileAction.
 
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

FileAction

public FileAction(Expression uri,
                  EvaluableExpression mimeType,
                  EvaluableExpression encoding,
                  Element element,
                  AbstractAction parent)
           throws XMLException
Create a new instance of FileAction.

Parameters:
uri - The URI of the file, that will be the value of the property, as an Expression.
mimeType - The MIME type of the file.
encoding - The encoding of the file.
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
Unmarshaller for FileAction.

Parameters:
parent - The action depending from
element - The XML element to unmarshall.
Returns:
The OpenAction 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, an XFile object.

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