planet.commonapi.GML
Interface GMLFactory

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GMLFactoryImpl

public interface GMLFactory
extends java.io.Serializable

Its objective is build any required element to build an GML graph.

Author:
Jordi Pujol 21/02/2005

Method Summary
 GMLConstraint buildDefaultGMLConstraint()
          Build the GMLConstraint specified in the GML properties file.
 GMLEdge buildEdge(Id source, Id target, boolean directed)
          Build a GML edge with the specified values.
 GMLEdge buildEdge(Id source, Id target, boolean directed, java.lang.String fill)
          Build a GML edge with the specified values.
 GMLGenerator buildGMLGenerator()
          Builds the GMLGenerator specified in the GML properties file.
 

Method Detail

buildEdge

public GMLEdge buildEdge(Id source,
                         Id target,
                         boolean directed)
                  throws InitializationException
Build a GML edge with the specified values. The fill color is used the predefined one (the appeared in GMLDefaultProperties.fill property).

Parameters:
source - Source node Id.
target - Destination node Id.
directed - true when the edge is directed. false in other case.
Returns:
An instance of GMLEdge.
Throws:
InitializationException - if an error occurs during the initialization.

buildEdge

public GMLEdge buildEdge(Id source,
                         Id target,
                         boolean directed,
                         java.lang.String fill)
                  throws InitializationException
Build a GML edge with the specified values. The fill color is used the predefined one (the appeared in GMLDefaultProperties.fill property).

Parameters:
source - Source node Id.
target - Destination node Id.
directed - true when the edge is directed. false in other case.
fill - Fill color in "#RRGGBB" format.
Returns:
An instance of GMLEdge.
Throws:
InitializationException - if an error occurs during the initialization.

buildGMLGenerator

public GMLGenerator buildGMLGenerator()
                               throws InitializationException
Builds the GMLGenerator specified in the GML properties file.

Returns:
The GMLGenerator.
Throws:
InitializationException - if an error occurs during the initialization.

buildDefaultGMLConstraint

public GMLConstraint buildDefaultGMLConstraint()
                                        throws InitializationException
Build the GMLConstraint specified in the GML properties file.

Returns:
The GMLConstraint.
Throws:
InitializationException - if an error occurs during the initialization.