org.fit.layout.tools.io

Class XMLOutputOperator

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.impl.BaseOperator

org.fit.layout.tools.io.XMLOutputOperator

All Implemented Interfaces:

AreaTreeOperator, ParametrizedOperation, Service

public class XMLOutputOperator
extends BaseOperator

This operator serializes the area tree to an XML file.

Author:

burgetr

Nested Class Summary

Nested classes/interfaces inherited from interface org.fit.layout.api.ParametrizedOperation

ParametrizedOperation.ValueType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filename Path to the output file/
protected java.lang.String[]	paramNames
protected ParametrizedOperation.ValueType[]	paramTypes
protected boolean	produceHeader Should we produce the XML header?

Constructor Summary

Constructors

Constructor and Description
XMLOutputOperator()
XMLOutputOperator(java.lang.String filename, boolean produceHeader)

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(AreaTree atree) Applies the operation to the given tree.
void	apply(AreaTree atree, Area root) Applies the operation to the given subtree of the tree.
java.lang.String	colorString(java.lang.String spec) Converts the CSS specification rgb(r,g,b) to #rrggbb
void	dumpTo(AreaTree tree, java.io.PrintWriter out) Formats the complete tag tree to an output stream
java.lang.String	getDescription() Obtains a longer description of the service.
java.lang.String	getFilename()
java.lang.String	getId() Obtains a unique ID of the service
java.lang.String	getName() Obtains a descriptive name of the service that may be presented to the user.
java.lang.String[]	getParamNames() Obtains a list of available parameter names of the operation.
ParametrizedOperation.ValueType[]	getParamTypes() Obtains a list of available parameter value types.
boolean	getProduceHeader()
void	setFilename(java.lang.String filename)
void	setProduceHeader(boolean produceHeader)

Methods inherited from class org.fit.layout.impl.BaseOperator

toString

Methods inherited from class org.fit.layout.impl.BaseParametrizedOperation

getParam, getParamRange, setParam

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fit.layout.api.ParametrizedOperation

getParam, getParamRange, setParam

Field Detail

produceHeader

protected boolean produceHeader

Should we produce the XML header?

filename

protected java.lang.String filename

Path to the output file/

paramNames

protected final java.lang.String[] paramNames

paramTypes

protected final ParametrizedOperation.ValueType[] paramTypes

Constructor Detail

XMLOutputOperator

public XMLOutputOperator()

XMLOutputOperator

public XMLOutputOperator(java.lang.String filename,
                 boolean produceHeader)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Service

Obtains a unique ID of the service

getName

public java.lang.String getName()

Description copied from interface: Service

Obtains a descriptive name of the service that may be presented to the user.

Returns:

the operator name

getDescription

public java.lang.String getDescription()

Description copied from interface: Service

Obtains a longer description of the service.

Returns:

the description

getParamNames

public java.lang.String[] getParamNames()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter names of the operation.

Returns:

an array of parameter names

getParamTypes

public ParametrizedOperation.ValueType[] getParamTypes()

Description copied from interface: ParametrizedOperation

Obtains a list of available parameter value types.

Returns:

an array of value types

getProduceHeader

public boolean getProduceHeader()

setProduceHeader

public void setProduceHeader(boolean produceHeader)

getFilename

public java.lang.String getFilename()

setFilename

public void setFilename(java.lang.String filename)

apply

public void apply(AreaTree atree)

Description copied from interface: AreaTreeOperator

Applies the operation to the given tree.

Parameters:

atree - the area tree to be modified.

apply

public void apply(AreaTree atree,
         Area root)

Description copied from interface: AreaTreeOperator

Applies the operation to the given subtree of the tree.

Parameters:

atree - the area tree to be modified.

root - the root node of the affected subtree.

dumpTo

public void dumpTo(AreaTree tree,
          java.io.PrintWriter out)

Formats the complete tag tree to an output stream

colorString

public java.lang.String colorString(java.lang.String spec)

Converts the CSS specification rgb(r,g,b) to #rrggbb

Parameters:

spec - the CSS color specification

Returns:

a #rrggbb string