com.highqsoft.odsgraph

Class BatchConfiguration

java.lang.Object

com.highqsoft.odsgraph.BatchConfiguration

All Implemented Interfaces:

DOTConfiguration

public class BatchConfiguration
extends java.lang.Object
implements DOTConfiguration

This is an implementation of the DOTConfiguration interface that can be used for batch mode.

Property Keyword	Datatype	Default	Description
RankSep	float	1.5	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
NodeSep	float	1.5	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
Rotate	int	0	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
RankDir	String	LR	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
AutoRankSep	boolean	true	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
Latitude	String	null	This is the size specification that is directly send to the dot tool. See the docuemntation of graphviz. The value are two integer values separated by colon (,) that specify the size of the output in inch. e.g. 4,4
FontSize	int	10	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
FontName	String	Helvetica	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
AutoNodeSep	boolean	true	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
Clustring	boolean	false	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
Ellipse	boolean	false	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
Filled	boolean	true	A parameter directly send to the graphviz tool. See the docuemntation of graphviz
BeName	boolean	false	If this parameter is true the name of the Baselements will be written to the node too.
WithHTMLReferences	boolean	false	If this parameter is true the generator creates references for use by HTML code.
OutputFilename	String	odsgraph.dot	The name of the output file.
PlumName	String	CORBA	The shortcut of the plugable component. Possible values are CORBA and ATHOS.
NameServicePort	int	2809	The port number of the name service.
NameServiceHot	String	localhost	The host name where the name service is running.
INIFile	String	ATHOS_INI	The ini file to be used for ATHOS plugable component.
User	String	null	The ASAM ODS username.
Password	String	null	The ASAM ODS password.
Filename	String	null	The ASAM ODS XML ATF filename passed to the ATHOS plugable component.
ServiceName	String	empty	The ASAM ODS service name.
OutputHandler	Classname	com.highqsoft.odsgraph.FatherChildHandler	The handle for output generation.
GenerateElementFiles	Boolean	no	When this configuration is set, for each element an UML diagram will be created in the output directory.

Since:

$Date: 2017/04/06 13:29:35 $

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Properties	properties

Constructor Summary

Constructors

Constructor and Description
BatchConfiguration(java.lang.String[] args) This constructor receives a filename that contains the configuration proprties.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	askGenerateElements() GenerateElementFiles.
boolean	autoNodeSep() auto node sep.
boolean	autoRankSep() auto rank sep.
boolean	beName() beNames.
boolean	clustring() clustering.
boolean	ellipse() shape ellipse.
boolean	filled() filled.
java.lang.String	getFontName() Get font name.
java.lang.String	getFontSize() Get the font size.
java.lang.String	getLatitude() Get size spezification.
AoSession	getSession() Get the session from the configuration.
OutputHandler	handler() Get the output handler.
java.lang.String	nodeSep() Get the node separator.
java.lang.String	outputFilename() Output filename.
java.lang.String	rankDir() Get the rank directory.
java.lang.String	rankSep() Get the rank separator.
java.lang.String	rotate() Get the rotation degrees.
boolean	withHTMLReferences() With references.
boolean	withPDFReferences() With references.

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected java.util.Properties properties

Constructor Detail

BatchConfiguration

public BatchConfiguration(java.lang.String[] args)
                   throws java.io.IOException

This constructor receives a filename that contains the configuration proprties.

Parameters:

filename -

Throws:

java.io.IOException

Method Detail

rankSep

public java.lang.String rankSep()

Get the rank separator. The property keyword is RankSep and is 1.5 by default.

Specified by:

rankSep in interface DOTConfiguration

nodeSep

public java.lang.String nodeSep()

Get the node separator. The property keyword is NodeSep and is 1.5 by default.

Specified by:

nodeSep in interface DOTConfiguration

rotate

public java.lang.String rotate()

Get the rotation degrees. The property keyword is Rotate and is 0 by default.

Specified by:

rotate in interface DOTConfiguration

rankDir

public java.lang.String rankDir()

Get the rank directory. The property keyword is RankDir and is LR (LeftRight) by default. Another value may TB (TopBottom)

Specified by:

rankDir in interface DOTConfiguration

autoRankSep

public boolean autoRankSep()

auto rank sep. The property keyword is AutoRankSep and is true by default.

Specified by:

autoRankSep in interface DOTConfiguration

getFontSize

public java.lang.String getFontSize()

Get the font size. The property keyword is FontSize and is 10 by default.

Specified by:

getFontSize in interface DOTConfiguration

getFontName

public java.lang.String getFontName()

Get font name. The property keyword is FontName and is Helvetica by default.

Specified by:

getFontName in interface DOTConfiguration

getLatitude

public java.lang.String getLatitude()

Get size spezification. The property keyword is Size and default value null.

Specified by:

getLatitude in interface DOTConfiguration

autoNodeSep

public boolean autoNodeSep()

auto node sep. The property keyword is AutoNodeSep and is true by default.

Specified by:

autoNodeSep in interface DOTConfiguration

clustring

public boolean clustring()

clustering. The property keyword is Clustering and is false by default.

Specified by:

clustring in interface DOTConfiguration

ellipse

public boolean ellipse()

shape ellipse. The property keyword is Ellipse and is false by default.

Specified by:

ellipse in interface DOTConfiguration

filled

public boolean filled()

filled. The property keyword is Filled and is true by default.

Specified by:

filled in interface DOTConfiguration

beName

public boolean beName()

beNames. The property keyword is BeName and is false by default.

Specified by:

beName in interface DOTConfiguration

withPDFReferences

public boolean withPDFReferences()

With references. Not yet implemented

Specified by:

withPDFReferences in interface DOTConfiguration

withHTMLReferences

public boolean withHTMLReferences()

With references. The property keyword is WithHTMLReferences and is false by default.

Specified by:

withHTMLReferences in interface DOTConfiguration

outputFilename

public java.lang.String outputFilename()

Output filename. The property keyword is OutputFilename and is odsgraph.dot by default.

getSession

public AoSession getSession()

Get the session from the configuration.

PlumName	corba
NameServicePort	2809
NameServiceHost	localhost
INIFile
User
Password
Filename
ServiceName

Returns:

askGenerateElements

public boolean askGenerateElements()

Description copied from interface: DOTConfiguration

GenerateElementFiles.

Specified by:

askGenerateElements in interface DOTConfiguration

handler

public OutputHandler handler()
                      throws java.lang.ClassNotFoundException,
                             java.lang.InstantiationException,
                             java.lang.IllegalAccessException

Get the output handler. The property keyword is handler and is com.highqsoft.odsgraph.FatherChildHandler by default. Currently there is another implementation available: com.highqsoft.odsgraph.PlainHandler
the returned class must implement com.highqsoft.odsgraph.OutputHandler interface.

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException