Package cz.vutbr.fit.layout.io
Class XMLOutputOperator
- java.lang.Object
-
- cz.vutbr.fit.layout.impl.BaseService
-
- cz.vutbr.fit.layout.impl.BaseParametrizedOperation
-
- cz.vutbr.fit.layout.impl.BaseOperator
-
- cz.vutbr.fit.layout.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
-
-
Field Summary
Fields Modifier and Type Field Description protected String
filename
Path to the output file/protected boolean
produceHeader
Should we produce the XML header?
-
Constructor Summary
Constructors Constructor Description XMLOutputOperator()
XMLOutputOperator(String filename, boolean produceHeader)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.String
colorString(String spec)
Converts the CSS specification rgb(r,g,b) to #rrggbbList<Parameter>
defineParams()
Creates the parameter definition for this operation.void
dumpTo(AreaTree tree, PrintWriter out)
Formats the complete tag tree to an output streamString
getCategory()
A category that allows to group similar services.String
getDescription()
Obtains a longer description of the service.String
getFilename()
String
getId()
Obtains a unique ID of the serviceString
getName()
Obtains a descriptive name of the service that may be presented to the user.boolean
getProduceHeader()
void
setFilename(String filename)
void
setProduceHeader(boolean produceHeader)
-
Methods inherited from class cz.vutbr.fit.layout.impl.BaseOperator
toString
-
Methods inherited from class cz.vutbr.fit.layout.impl.BaseParametrizedOperation
getParam, getParams, getParamString, setParam
-
Methods inherited from class cz.vutbr.fit.layout.impl.BaseService
getServiceManager, setServiceManager
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface cz.vutbr.fit.layout.api.ParametrizedOperation
getParam, getParams, getParamString, setParam
-
Methods inherited from interface cz.vutbr.fit.layout.api.Service
setServiceManager
-
-
-
-
Field Detail
-
produceHeader
protected boolean produceHeader
Should we produce the XML header?
-
filename
protected String filename
Path to the output file/
-
-
Constructor Detail
-
XMLOutputOperator
public XMLOutputOperator()
-
XMLOutputOperator
public XMLOutputOperator(String filename, boolean produceHeader)
-
-
Method Detail
-
getId
public String getId()
Description copied from interface:Service
Obtains a unique ID of the service
-
getName
public 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 String getDescription()
Description copied from interface:Service
Obtains a longer description of the service.- Returns:
- the description
-
getCategory
public String getCategory()
Description copied from interface:Service
A category that allows to group similar services.- Returns:
- Category name or
null
when no category is assigned.
-
defineParams
public List<Parameter> defineParams()
Description copied from class:BaseParametrizedOperation
Creates the parameter definition for this operation.- Overrides:
defineParams
in classBaseParametrizedOperation
- Returns:
- The list of parameters.
-
getProduceHeader
public boolean getProduceHeader()
-
setProduceHeader
public void setProduceHeader(boolean produceHeader)
-
getFilename
public String getFilename()
-
setFilename
public void setFilename(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, PrintWriter out)
Formats the complete tag tree to an output stream
-
-