cage
Class StaticGeneratorInfo

java.lang.Object
  cage.GeneratorInfo
      cage.StaticGeneratorInfo

public class StaticGeneratorInfo
extends GeneratorInfo

Implementation of GeneratorInfo that sets all settings using setters and doesn't calculate any of the values.

Field Summary

Fields inherited from class cage.GeneratorInfo

ALL_EXPERT_MODES, EMBED_EXPERT, GENERATOR_EXPERT, NO_EXPERT_MODE

Constructor Summary

StaticGeneratorInfo(java.lang.String[][] generator, Embedder embedder, java.lang.String filename, int maxFacesize)
Creates a StaticGeneratorInfo object with the given generator commands, embedder, filename and maximum face size.

StaticGeneratorInfo(java.lang.String[][] generator, Embedder embedder, java.lang.String filename, int maxFacesize, boolean reembed2DEnabled)
Creates a StaticGeneratorInfo object with the given generator commands, embedder, filename and maximum face size.

StaticGeneratorInfo(java.lang.String[][] generator, Embedder embedder, java.lang.String filename, int maxFacesize, boolean reembed2DEnabled, ElementRule elementRule)

StaticGeneratorInfo(java.lang.String[][] generator, Embedder embedder, java.lang.String filename, int maxFacesize, boolean reembed2DEnabled, ElementRule elementRule, int expertMode)

StaticGeneratorInfo(java.lang.String[][] generator, Embedder embedder, java.lang.String filename, int maxFacesize, ElementRule elementRule)

StaticGeneratorInfo(java.lang.String[][] generator, Embedder embedder, java.lang.String filename, int maxFacesize, ElementRule elementRule, int expertMode)

Method Summary

ElementRule	getElementRule() Returns the element rule to be used with this generator.
Embedder	getEmbedder() Returns the embedder to be used for this generator.
int	getExpertMode() Returns the expert mode of this generator.
java.lang.String	getFilename() Returns the filename of the output file.
java.lang.String[][]	getGenerator() Returns the generator.
int	getMaxFacesize() Returns the maximum size of a face in the graphs from this generator.
boolean	isReembed2DEnabled() Returns whether the 2D embedding can be reembedded with another face as outer face.
void	setEmbedder(Embedder embedder) Sets the embedder to be used for this generator.
void	setGenerator(java.lang.String[][] generator) Sets the generator.

Methods inherited from class cage.GeneratorInfo

createExpertMode, expertModeContains, expertModeExcludes, expertModeIncludes, getExcludedExpertModes, getGeneratorName, getIncludedExpertModes, setGeneratorName

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticGeneratorInfo

public StaticGeneratorInfo(java.lang.String[][] generator,
                           Embedder embedder,
                           java.lang.String filename,
                           int maxFacesize)

Creates a StaticGeneratorInfo object with the given generator commands, embedder, filename and maximum face size. Reembedding is enabled. The expert mode is disabled for this generator and a default ValencyElementRule is used that maps the vertices as follows:

Degree	Element
1	H
2	O
3	C
4	Si
5	N
6	S
7	I

Parameters:

generator - The generator commands

embedder - The embedder

filename - The filename for export to file

maxFacesize - The maximum face size

StaticGeneratorInfo

public StaticGeneratorInfo(java.lang.String[][] generator,
                           Embedder embedder,
                           java.lang.String filename,
                           int maxFacesize,
                           boolean reembed2DEnabled)

Creates a StaticGeneratorInfo object with the given generator commands, embedder, filename and maximum face size. Reembedding is enabled based on the value of reembed2DEnabled. The expert mode is disabled for this generator and a default ValencyElementRule is used that maps the vertices as follows:

Degree	Element
1	H
2	O
3	C
4	Si
5	N
6	S
7	I

Parameters:

generator - The generator commands

embedder - The embedder

filename - The filename for export to file

maxFacesize - The maximum face size

reembed2DEnabled - Is reembedding enabled.

StaticGeneratorInfo

public StaticGeneratorInfo(java.lang.String[][] generator,
                           Embedder embedder,
                           java.lang.String filename,
                           int maxFacesize,
                           ElementRule elementRule)

StaticGeneratorInfo

public StaticGeneratorInfo(java.lang.String[][] generator,
                           Embedder embedder,
                           java.lang.String filename,
                           int maxFacesize,
                           boolean reembed2DEnabled,
                           ElementRule elementRule)

StaticGeneratorInfo

public StaticGeneratorInfo(java.lang.String[][] generator,
                           Embedder embedder,
                           java.lang.String filename,
                           int maxFacesize,
                           ElementRule elementRule,
                           int expertMode)

StaticGeneratorInfo

public StaticGeneratorInfo(java.lang.String[][] generator,
                           Embedder embedder,
                           java.lang.String filename,
                           int maxFacesize,
                           boolean reembed2DEnabled,
                           ElementRule elementRule,
                           int expertMode)

Method Detail

getGenerator

public java.lang.String[][] getGenerator()

Description copied from class: GeneratorInfo

Returns the generator. This generator consists of a 2-dimensional array of Strings. Each array of Strings represents a command and the different options needed for this command. These commands and their options are then piped together in the order that the arrays are organized in the array of arrays.

Specified by:

getGenerator in class GeneratorInfo

Returns:

An array of arrays of Strings representing the generator.

setGenerator

public void setGenerator(java.lang.String[][] generator)

Description copied from class: GeneratorInfo

Sets the generator. This generator consists of a 2-dimensional array of Strings. Each array of Strings represents a command and the different options needed for this command. These commands and their options are then piped together in the order that the arrays are organized in the array of arrays.

Specified by:

setGenerator in class GeneratorInfo

Parameters:

generator - An array of arrays of Strings representing the generator.

getEmbedder

public Embedder getEmbedder()

Description copied from class: GeneratorInfo

Returns the embedder to be used for this generator.

Specified by:

getEmbedder in class GeneratorInfo

Returns:

The embedder for this generator.

setEmbedder

public void setEmbedder(Embedder embedder)

Description copied from class: GeneratorInfo

Sets the embedder to be used for this generator.

Specified by:

setEmbedder in class GeneratorInfo

Parameters:

embedder - The embedder for this generator.

See Also:

EmbedFactory

getFilename

public java.lang.String getFilename()

Description copied from class: GeneratorInfo

Returns the filename of the output file.

Specified by:

getFilename in class GeneratorInfo

Returns:

The filename of the output file.

getMaxFacesize

public int getMaxFacesize()

Description copied from class: GeneratorInfo

Returns the maximum size of a face in the graphs from this generator. This may be zero if the maximum size is unknown.

Specified by:

getMaxFacesize in class GeneratorInfo

Returns:

The maximum size of a face in an outputted graph, or 0 if unknown.

isReembed2DEnabled

public boolean isReembed2DEnabled()

Description copied from class: GeneratorInfo

Returns whether the 2D embedding can be reembedded with another face as outer face. This affects the TwoView viewer's ability to react to mouse clicks inside a face, asking for a new embedding in which this face becomes the exterior one.

Specified by:

isReembed2DEnabled in class GeneratorInfo

Returns:

true if reembedding is enable and false in the other case

getElementRule

public ElementRule getElementRule()

Returns the element rule to be used with this generator.

Specified by:

getElementRule in class GeneratorInfo

Returns:

The element rule to be used with this generator.

getExpertMode

public int getExpertMode()

Description copied from class: GeneratorInfo

Returns the expert mode of this generator.

Specified by:

getExpertMode in class GeneratorInfo

Returns:

the expert mode of this generator

See Also:

GeneratorInfo.createExpertMode(int, int)