fr.efl.chaine.xslt.config

Class Output

java.lang.Object

fr.efl.chaine.xslt.config.Output

All Implemented Interfaces:

Verifiable

public class Output
extends Object
implements Verifiable

An output definition

Author:

ext-cmarchand

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Output.OutputProperties
static class	Output.OutputPropertyEntry

Field Summary

Fields

Modifier and Type	Field and Description
static HashMap<String,Output.OutputPropertyEntry>	VALID_OUTPUT_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
Output()

Method Summary

Modifier and Type	Method and Description
String	getConsole() Returns the console to use.
File	getDestinationFile(File sourceFile, HashMap<net.sf.saxon.s9api.QName,ParameterValue> parameters) Renvoie le fichier destination
String	getId()
Properties	getOutputProperties() Returns a copy of outputProperties
String	getOutputProperty(String key)
boolean	isConsoleOutput()
boolean	isNullOutput() Returns true if the output should not be written anywhere
void	setAbsolute(String absolute)
void	setConsole(String console) Defines which console to use.
void	setId(String id)
void	setName(String name)
void	setNull(boolean nullOutput)
void	setOutputProperties(Properties props) Defines outputProperties, based on props values.
void	setOutputProperty(String key, String value) Sets a new output property value.
void	setPrefix(String prefix)
void	setRelativePath(String relativePath)
void	setRelativeTo(String relativeTo)
void	setSuffix(String suffix)
String	toString()
String	toString(String prefix)
void	unsetOutputProperty(String key)
void	verify() Réalise les vérifications nécessaires sur l'instance, et jette une exception en cas de problème

Methods inherited from class java.lang.Object

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

Field Detail

VALID_OUTPUT_PROPERTIES

public static final HashMap<String,Output.OutputPropertyEntry> VALID_OUTPUT_PROPERTIES

Constructor Detail

Output

public Output()

Method Detail

setRelativeTo

public void setRelativeTo(String relativeTo)

setRelativePath

public void setRelativePath(String relativePath)

setAbsolute

public void setAbsolute(String absolute)

setPrefix

public void setPrefix(String prefix)

setSuffix

public void setSuffix(String suffix)

setName

public void setName(String name)

setNull

public void setNull(boolean nullOutput)

setOutputProperties

public void setOutputProperties(Properties props)
                         throws InvalidSyntaxException

Defines outputProperties, based on props values. It does not modify outputProperties Properties object, it defines the values in. It call setOutputProperty(java.lang.String, java.lang.String) for each property All existing properties are removed before setting new properties.

Parameters:

props - The properties to set

Throws:

InvalidSyntaxException - If a property or a value is invalid

setOutputProperty

public void setOutputProperty(String key,
                              String value)
                       throws InvalidSyntaxException

Sets a new output property value. If this property was allready defined, it is overriden

Parameters:

key - The property name

value - The property value

Throws:

InvalidSyntaxException - If the property is invalid, or if the value is not allowed for the property

unsetOutputProperty

public void unsetOutputProperty(String key)

isNullOutput

public boolean isNullOutput()

Returns true if the output should not be written anywhere

Returns:

true if this output should produce nothing

getOutputProperties

public Properties getOutputProperties()

Returns a copy of outputProperties

Returns:

A new copy of output properties

getOutputProperty

public String getOutputProperty(String key)

getDestinationFile

public File getDestinationFile(File sourceFile,
                               HashMap<net.sf.saxon.s9api.QName,ParameterValue> parameters)
                        throws InvalidSyntaxException,
                               URISyntaxException

Renvoie le fichier destination

Parameters:

sourceFile - Le fichier source traité

parameters - Parameters to give. Should be used only to parse the escapes

Returns:

The file to create

Throws:

InvalidSyntaxException - If this output has no been correctly defined

URISyntaxException - If the constructed URI is no valid

verify

public void verify()
            throws InvalidSyntaxException

Description copied from interface: Verifiable

Réalise les vérifications nécessaires sur l'instance, et jette une exception en cas de problème

Specified by:

verify in interface Verifiable

Throws:

InvalidSyntaxException - If something is wrong

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(String prefix)

getConsole

public String getConsole()

Returns the console to use.

Returns:

"out", "err" or null

setConsole

public void setConsole(String console)
                throws InvalidSyntaxException

Defines which console to use.

Parameters:

console - Only "out", "err" and null are valid values

Throws:

InvalidSyntaxException - If console is not a valid value.

isConsoleOutput

public boolean isConsoleOutput()

getId

public String getId()

setId

public void setId(String id)