com.tensegrity.gui.graphdocument
Class DocumentFactory

java.lang.Object
  com.tensegrity.gui.graphdocument.DocumentFactory

Direct Known Subclasses:

DocumentFactoryImpl, DocumentFactoryImpl

public abstract class DocumentFactory

extends java.lang.Object

The abstract base Class for DocumentFactory's.

Version:

$Id: DocumentFactory.java,v 1.14 2005/12/16 10:44:07 MichaelKegel Exp $

Author:

M.Kegel, S. Rutz

Constructor Summary

DocumentFactory()
Constructs a new DocumentFactory instance.

Method Summary

abstract GraphDocument	newGraphDocument(java.lang.String name, ApplicationFrame applicationFrame, DragContext dragcontext) This method returns a new graphdocument.
abstract GraphDocument	newGraphDocument(java.lang.String name, ApplicationFrame applicationFrame, GraphController graphcontroller, VisualGraphView visualgraphview) This method returns a new graphdocument.
abstract GraphDocument	newGraphDocument(java.lang.String name, ApplicationFrame applicationFrame, GraphController graphcontroller, VisualGraphView visualgraphview, DragContext dragcontext) This method returns a new graphdocument.
GraphDocument	newGraphDocument(java.lang.String name, GraphApplication graphapplication, DragContext dragcontext) Deprecated. Use newGraphDocument(String, ApplicationFrame, GraphController, VisualGraphView, DragContext) instead!
GraphDocument	newGraphDocument(java.lang.String name, GraphApplication graphapplication, GraphController graphcontroller, VisualGraphView visualgraphview) Deprecated. Use newGraphDocument(String, ApplicationFrame, GraphController, VisualGraphView) instead!
GraphDocument	newGraphDocument(java.lang.String name, GraphApplication graphapplication, GraphController graphcontroller, VisualGraphView visualgraphview, DragContext dragcontext) Deprecated. Use newGraphDocument(String, ApplicationFrame, GraphController, VisualGraphView, DragContext) instead!
abstract GraphDocument	newGraphDocument(java.lang.String name, GraphController graphcontroller, VisualGraphView visualgraphview) This method returns a new graphdocument.
abstract GraphDocument	newGraphDocument(java.lang.String name, GraphController graphcontroller, VisualGraphView visualgraphview, DragContext dragcontext) This method returns a new graphdocument.
static DocumentFactory	newInstance() This method creates a new instance of the actual GraphViewFactory implementation.
static void	setDefaultFactory(java.lang.String defaultfactory) Sets the default factory class name.
static void	setServiceFile(java.lang.String servicefile) Sets the service file to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentFactory

public DocumentFactory()

Constructs a new DocumentFactory instance.

Method Detail

setServiceFile

public static final void setServiceFile(java.lang.String servicefile)

Sets the service file to use.

Parameters:

servicefile - the servicefile to use.

setDefaultFactory

public static final void setDefaultFactory(java.lang.String defaultfactory)

Sets the default factory class name.

Parameters:

defaultfactory - the default factory class name.

newGraphDocument

public abstract GraphDocument newGraphDocument(java.lang.String name,
                                               ApplicationFrame applicationFrame,
                                               GraphController graphcontroller,
                                               VisualGraphView visualgraphview,
                                               DragContext dragcontext)

This method returns a new graphdocument.

Parameters:

name - name of the document.

applicationFrame - reference to the application context.

graphcontroller - the graphcontroller instance that keeps the model.

visualgraphview - the visualgraph instance to show in the document.

dragcontext - a drag context that provide additional information about the recently dragged object.

Returns:

the created graph document instance.

newGraphDocument

public abstract GraphDocument newGraphDocument(java.lang.String name,
                                               ApplicationFrame applicationFrame,
                                               GraphController graphcontroller,
                                               VisualGraphView visualgraphview)

This method returns a new graphdocument.

Parameters:

name - name of the document.

applicationFrame - reference to the application context.

graphcontroller - the graphcontroller instance that keeps the model.

visualgraphview - the visualgraph instance to show in the document.

Returns:

the created graph document instance.

newGraphDocument

public abstract GraphDocument newGraphDocument(java.lang.String name,
                                               ApplicationFrame applicationFrame,
                                               DragContext dragcontext)

This method returns a new graphdocument.

Parameters:

name - name of the document.

applicationFrame - reference to the application context.

dragcontext - a drag context that provide additional information about the recently dragged object.

Returns:

the created graph document instance.

newGraphDocument

public GraphDocument newGraphDocument(java.lang.String name,
                                      GraphApplication graphapplication,
                                      GraphController graphcontroller,
                                      VisualGraphView visualgraphview,
                                      DragContext dragcontext)

Deprecated. Use newGraphDocument(String, ApplicationFrame, GraphController, VisualGraphView, DragContext) instead!

This method returns a new graphdocument.

Parameters:

name - name of the document.

graphapplication - reference to the application context.

graphcontroller - the graphcontroller instance that keeps the model.

visualgraphview - the visualgraph instance to show in the document.

dragcontext - a drag context that provide additional information about the recently dragged object.

Returns:

the created graph document instance.

newGraphDocument

public abstract GraphDocument newGraphDocument(java.lang.String name,
                                               GraphController graphcontroller,
                                               VisualGraphView visualgraphview,
                                               DragContext dragcontext)

This method returns a new graphdocument.

Parameters:

name - name of the document.

graphcontroller - the graphcontroller instance that keeps the model.

visualgraphview - the visualgraph instance to show in the document.

dragcontext - a drag context that provide additional information about the recently dragged object.

Returns:

the created graph document instance.

newGraphDocument

public GraphDocument newGraphDocument(java.lang.String name,
                                      GraphApplication graphapplication,
                                      GraphController graphcontroller,
                                      VisualGraphView visualgraphview)

Deprecated. Use newGraphDocument(String, ApplicationFrame, GraphController, VisualGraphView) instead!

This method returns a new graphdocument.

Parameters:

name - name of the document.

graphapplication - reference to the application context.

graphcontroller - the graphcontroller instance that keeps the model.

visualgraphview - the visualgraph instance to show in the document.

Returns:

the created graph document instance.

newGraphDocument

public abstract GraphDocument newGraphDocument(java.lang.String name,
                                               GraphController graphcontroller,
                                               VisualGraphView visualgraphview)

This method returns a new graphdocument.

Parameters:

name - name of the document.

graphcontroller - the graphcontroller instance that keeps the model.

visualgraphview - the visualgraph instance to show in the document.

Returns:

the created graph document instance.

newGraphDocument

public GraphDocument newGraphDocument(java.lang.String name,
                                      GraphApplication graphapplication,
                                      DragContext dragcontext)

Deprecated. Use newGraphDocument(String, ApplicationFrame, GraphController, VisualGraphView, DragContext) instead!

This method returns a new graphdocument.

Parameters:

name - name of the document.

graphapplication - reference to the application context.

dragcontext - a drag context that provide additional information about the recently dragged object.

Returns:

the created graph document instance.

newInstance

public static DocumentFactory newInstance()

This method creates a new instance of the actual GraphViewFactory implementation.

Returns:

the graphviewfactory instance.

Throws:

a - FactoryConfigurationError is thrown whenever something goes wrong. For instance, there is no factory classname found or the factory class itself is not found or not accessable and so on