charger

Class IOManager

Object

charger.IOManager

public class IOManager
extends Object

Responsible for file input/output for the CG system. Parses graph information in a string (in "CharGer" format), then inserts the new graph objects. Since each new object requires a new/unique ID number, IOManager must keep track of both the old ID (to determine what an object was linked to in the string's graphs) and the new ID (to determine how to link the object in its new incarnation here). Implemented as a class because there may be reason to be loading more than one frame at a time.

Author:

Harry S. Delugach ( delugach@uah.edu ) Copyright (c) 1998-2020 by Harry S. Delugach.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOManager.TransferableImage

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayList<String>	imageFormats Holds the list of image formats supported by the current image writer
(package private) static Hashtable	OldNewMapping This table is used by IOManager instances to maintain an old-new mapping.
protected JFrame	ownerFrame

Constructor Summary

Constructors

Constructor and Description
IOManager(JFrame f)

Method Summary

Modifier and Type	Method and Description
static File	chooseViaFileSaveDialog(Frame owner, File initialChoiceFile, String promptstring) Runs the file dialog that lets the user choose the filename and location.
static File	FileToGraph(File absFile, Graph targetGraph) Loads a graph from a file to a graph.
static File	FileToGraph(File absFile, Graph targetGraph, Point2D.Double translateBy) Loads from a cgx file to a graph.
static File	getAbsoluteFile(String filename, chargerlib.FileFormat format) Establish the absolute file for a given filename and its intended format.
static File	GraphToFile(Graph g, chargerlib.FileFormat format, String filename, Frame owner) Saves a CharGer Graph to a file.
static BufferedImage	graphToImage(Graph g) Takes an entire graph and formats it as a bitmap image.
static GNode	hookUp(GEdge ge, GraphObjectID oldID, Graph gr, boolean keepIDs) uses the old-to-new mapping to attach an edge to its new ends
static void	initializeImageFormatList() Sets up the imageFormats array list with all the valid image types supported by the local image writer.
protected static void	loadGraph2(BufferedReader f, Graph targetGraph) Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph
protected static void	loadGraph2(BufferedReader f, Graph targetGraph, Point translateBy) Loads (reads) a graph from a file in CharGer version 2 format and attaches it to an existing (i.e., non-null, but possibly empty) graph
protected static void	loadGraph3(BufferedReader f, Graph targetGraph) Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph
protected static void	loadGraph3(BufferedReader f, Graph targetGraph, Point translateBy) Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph, using the "new" version 3 format
protected static void	loadGraphCGX(File f, Graph targetGraph, Point2D.Double translateBy) Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph, using the XML version 3.8 format
protected static void	loadGraphXML(File f, Graph target) Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph
static GraphObject	parseOneObject(String s, Graph rootGraph, boolean ignoreOwner, Point translateBy, boolean keepIDs) Tokenizes and parses a string assuming it was written using the saveGraph2 rules, then creates a correct CharGer graph object based on what was parsed.
static GraphObject	parseOneObject2(String s, Graph rootGraph, boolean ignoreNesting, Point translateBy, boolean keepIDs) Tokenizes and parses a string assuming it was written using the saveGraph rules for version 2, then creates a correct CharGer graph object based on what was parsed.
static void	saveGraph2(BufferedWriter writer, Graph gr) EditFrame makes the header, but GraphObject makes each object's string all found in toString methods in the GraphObject classes.
static void	saveGraph38XML(BufferedWriter f, Graph gr) The output routine for versions 3.8 and later.
static void	saveGraph4(OutputStream os, Graph gr) EditFrame makes the header, but GraphObject makes each object's string all found in toString methods in the GraphObject classes.
static void	saveGraphAsBitmapImage(Graph g, chargerlib.FileFormat format, File f) Uses the ImageIO methods to write the graph in the given format This overwrites the file; use chooseViaFileSaveDialog if you need the user to confirm overwriting.
static void	saveGraphAsTextFormat(Graph g, chargerlib.FileFormat format, File chosenOne) Save as one of the text or export formats.
static void	saveGraphAsVectorGraphic(Graph g, chargerlib.FileFormat format, String filename) Uses the ImageIO methods to write the graph in pdf, svg or eps format.
private static void	saveGraphCGIF2007(BufferedWriter f, Graph gr, boolean includeCharGerInfo)
static ArrayList<GraphObject>	StringToGraph(String s, Graph targetGraph, Point translateBy, boolean keepIDs) Loads a graph from a CharGer formatted string

Methods inherited from class Object

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

Field Detail

OldNewMapping

static Hashtable OldNewMapping

This table is used by IOManager instances to maintain an old-new mapping. Key is a string representing the old ID (in String form), value is the new ID (in String form)

ownerFrame

protected JFrame ownerFrame

imageFormats

public static ArrayList<String> imageFormats

Holds the list of image formats supported by the current image writer

Constructor Detail

IOManager

public IOManager(JFrame f)

Method Detail

FileToGraph

public static File FileToGraph(File absFile,
                               Graph targetGraph,
                               Point2D.Double translateBy)
                        throws CGFileException,
                               CGStorageError

Loads from a cgx file to a graph. Does error checking on the filename, graph, etc.

Parameters:

absFile - contains the absolute non-null File from which graph is to be loaded

targetGraph - The graph to which the loaded objects will be added

translateBy - The offset on the canvas by which the new parsed objects are translated. If null, then all layout information is ignored. If (0,0), perhaps the two-argument version should be used.

Returns:

file object if the load succeeded, otherwise throw CGFileException

Throws:

CGFileException

CGStorageError

See Also:

loadGraph3(java.io.BufferedReader, charger.obj.Graph, java.awt.Point), FileToGraph(java.io.File, charger.obj.Graph, java.awt.geom.Point2D.Double)

FileToGraph

public static File FileToGraph(File absFile,
                               Graph targetGraph)
                        throws CGFileException,
                               CGStorageError

Loads a graph from a file to a graph. Does error checking on the filename, graph, etc.

Parameters:

absFile - contains fully-qualified file name from which graph is to be loaded

targetGraph - The graph to which the loaded objects will be added

Returns:

filename if the load succeeded, otherwise throw CGFileException

Throws:

CGFileException

CGStorageError

See Also:

loadGraph3(java.io.BufferedReader, charger.obj.Graph, java.awt.Point)

loadGraph2

protected static void loadGraph2(BufferedReader f,
                                 Graph targetGraph,
                                 Point translateBy)
                          throws CGFileException,
                                 CGSyntaxException

Loads (reads) a graph from a file in CharGer version 2 format and attaches it to an existing (i.e., non-null, but possibly empty) graph

Parameters:

f - An already-opened file object pointing to a CharGer formatted version of the graph desired

targetGraph - An already existing graph to which the new contents will be attached

translateBy - An x,y offset by which the loaded objects will be translated.

Throws:

CGFileException

CGSyntaxException

See Also:

saveGraph2(java.io.BufferedWriter, charger.obj.Graph)

loadGraph2

protected static void loadGraph2(BufferedReader f,
                                 Graph targetGraph)
                          throws CGFileException

Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph

Parameters:

f - A text file containing a text version of the graph desired

targetGraph - An already existing graph to which the new contents will be attached

Throws:

CGFileException

See Also:

GraphToFile(charger.obj.Graph, chargerlib.FileFormat, java.lang.String, java.awt.Frame)

loadGraph3

protected static void loadGraph3(BufferedReader f,
                                 Graph targetGraph,
                                 Point translateBy)
                          throws CGFileException

Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph, using the "new" version 3 format

Parameters:

f - An already-opened file object pointing to a CharGer formatted version of the graph desired

targetGraph - An already existing graph to which the new contents will be attached

translateBy - An x,y offset by which the loaded objects will be translated.

Throws:

CGFileException

See Also:

saveGraph2(java.io.BufferedWriter, charger.obj.Graph)

loadGraph3

protected static void loadGraph3(BufferedReader f,
                                 Graph targetGraph)
                          throws CGFileException

Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph

Parameters:

f - A text file containing a text version of the graph desired

Throws:

CGFileException

See Also:

GraphToFile(charger.obj.Graph, chargerlib.FileFormat, java.lang.String, java.awt.Frame)

loadGraphCGX

protected static void loadGraphCGX(File f,
                                   Graph targetGraph,
                                   Point2D.Double translateBy)

Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph, using the XML version 3.8 format

Parameters:

f - An already-opened file object pointing to a XML formatted version of the graph desired

targetGraph - An already existing graph to which the new contents will be attached

translateBy - An x,y offset by which the loaded objects will be translated. If null, then ignore any layout information.. This is not the same as translating by (0,0).

See Also:

saveGraph38XML(java.io.BufferedWriter, charger.obj.Graph)

loadGraphXML

protected static void loadGraphXML(File f,
                                   Graph target)
                            throws CGFileException

Loads (reads) a graph from a file and attaches it to an existing (i.e., non-null, but possibly empty) graph

Parameters:

f - A text file containing a text version of the graph desired

Throws:

CGFileException

See Also:

GraphToFile(charger.obj.Graph, chargerlib.FileFormat, java.lang.String, java.awt.Frame)

StringToGraph

public static ArrayList<GraphObject> StringToGraph(String s,
                                                   Graph targetGraph,
                                                   Point translateBy,
                                                   boolean keepIDs)
                                            throws CGStorageError

Loads a graph from a CharGer formatted string

Parameters:

s - String containing one or more lines of parsable text

targetGraph - The graph in which to store the found objects

translateBy - The x,y coordinates to use in translating the parsed objects

keepIDs - Whether to keep existing IDs or create new ones

Returns:

list of all the new objects it parsed

Throws:

CGStorageError

See Also:

loadGraph3(java.io.BufferedReader, charger.obj.Graph, java.awt.Point)

parseOneObject2

public static GraphObject parseOneObject2(String s,
                                          Graph rootGraph,
                                          boolean ignoreNesting,
                                          Point translateBy,
                                          boolean keepIDs)
                                   throws CGSyntaxException

Tokenizes and parses a string assuming it was written using the saveGraph rules for version 2, then creates a correct CharGer graph object based on what was parsed.

Parameters:

s - a CharGer object string representing some graph object (not including a line.separator)

rootGraph - an already-allocated (empty or non-empty) graph node that will be filled in

ignoreNesting - disregard any owner graph information in the string; i.e., don't try to connect this object to an owning graph.

translateBy - an amount to translate the parsed object's position

keepIDs - whether to keep the internal IDs or create new ones

Returns:

the single graph object parsed; if a new object, then we need to know that!!!

Throws:

CGSyntaxException

See Also:

saveGraph2(java.io.BufferedWriter, charger.obj.Graph)

parseOneObject

public static GraphObject parseOneObject(String s,
                                         Graph rootGraph,
                                         boolean ignoreOwner,
                                         Point translateBy,
                                         boolean keepIDs)

Tokenizes and parses a string assuming it was written using the saveGraph2 rules, then creates a correct CharGer graph object based on what was parsed. Used when reading in version 3 graphs from a file and when copying/pasting internally.

Parameters:

s - a CharGer object string representing some graph object (not including a line.separator)

rootGraph - an already-allocated (empty or non-empty) graph node that will be filled in

ignoreOwner - whether to consider the object's owner in creating the object

translateBy - an amount to translate the parsed object's position

keepIDs - whether to keep the existing IDs or create new ones

Returns:

the single graph object parsed; if a new object, then we need to know that!!!

See Also:

saveGraph2(java.io.BufferedWriter, charger.obj.Graph)

hookUp

public static GNode hookUp(GEdge ge,
                           GraphObjectID oldID,
                           Graph gr,
                           boolean keepIDs)

uses the old-to-new mapping to attach an edge to its new ends

Parameters:

ge - the edge to be attached to its appropriate (new) nodes

oldID - the object's ID assigned when the line's info was written

gr - the (new) graph which will own the new edge

keepIDs - whether to keep the old ident or lookup a new one

getAbsoluteFile

public static File getAbsoluteFile(String filename,
                                   chargerlib.FileFormat format)

Establish the absolute file for a given filename and its intended format. If it's relative, use the Hub.GraphFolderFile value to determine the absolute path.

Parameters:

filename - original filename, may be either absolute or relative

format - used for replacing the extension of the given filename

Returns:

an absolutely absolute file name

See Also:

Global.GraphFolderFile

chooseViaFileSaveDialog

public static File chooseViaFileSaveDialog(Frame owner,
                                           File initialChoiceFile,
                                           String promptstring)
                                    throws CGFileException

Runs the file dialog that lets the user choose the filename and location. Checks to see if file already exists; if it does, the user must confirm.

Parameters:

owner - the frame that will own the modal dialog.

initialChoiceFile - the initial file display information

promptstring - The string to cue the user what is expected

Returns:

thefile chosen by the user; null if none was chosen.

Throws:

CGFileException

GraphToFile

public static File GraphToFile(Graph g,
                               chargerlib.FileFormat format,
                               String filename,
                               Frame owner)
                        throws CGFileException

Saves a CharGer Graph to a file. If there's a human user in front, then owner is non-null and dialogs are displayed to get the input. If no human user, then owner is null and the filename is used directly. If one of the "content" formats -- CHARGER38, CHARGER4 or CGIF2007, then we first write to a temporary file in case there's an error in writing. If an image format, then the file is written to directly -- if there's an error then the image file may be trashed.

Parameters:

format - What type of output format is to be written.

filename - The name of the file to which the graph is to be written. either relative to whever Java thinks is the current directory or else absolute

g - The graph to be saved

owner - Frame to own the file dialogs; null if no user input is needed or required

Returns:

the file which was chosen; null if it didn't finish normally.

Throws:

CGFileException

See Also:

ImageIO.getWriterFormatNames()

saveGraph38XML

public static void saveGraph38XML(BufferedWriter f,
                                  Graph gr)

The output routine for versions 3.8 and later. EditFrame makes the header, but GraphObject makes each object's string all found in toString methods in the GraphObject classes. Uses XML format.

See Also:

saveGraph38XML(java.io.BufferedWriter, charger.obj.Graph), GraphObject.toString()

saveGraph4

public static void saveGraph4(OutputStream os,
                              Graph gr)

EditFrame makes the header, but GraphObject makes each object's string all found in toString methods in the GraphObject classes. Uses XML format.

See Also:

saveGraph38XML(java.io.BufferedWriter, charger.obj.Graph), GraphObject.toString()

saveGraph2

public static void saveGraph2(BufferedWriter writer,
                              Graph gr)

EditFrame makes the header, but GraphObject makes each object's string all found in toString methods in the GraphObject classes. Uses version 2's proprietary format, where values are separated by "|".

See Also:

GraphObject.toString()

saveGraphCGIF2007

private static void saveGraphCGIF2007(BufferedWriter f,
                                      Graph gr,
                                      boolean includeCharGerInfo)

graphToImage

public static BufferedImage graphToImage(Graph g)

Takes an entire graph and formats it as a bitmap image. In the future, should be able to format partial graphs, but for now, only works for a complete graph.

Parameters:

g - the graph to be imaged; does not have to be in a frame.

Returns:

the entire graph as a BufferedImage in the given format, scaled by the scale factor given.

See Also:

GraphToFile(charger.obj.Graph, chargerlib.FileFormat, java.lang.String, java.awt.Frame)

initializeImageFormatList

public static void initializeImageFormatList()

Sets up the imageFormats array list with all the valid image types supported by the local image writer.

saveGraphAsTextFormat

public static void saveGraphAsTextFormat(Graph g,
                                         chargerlib.FileFormat format,
                                         File chosenOne)
                                  throws CGFileException

Save as one of the text or export formats. This overwrites the file; use chooseViaFileSaveDialog if you need the user to confirm overwriting.

Parameters:

g - the graph to be saved/exported

format - the format of the output file desired

chosenOne - the file (already confirmed) that will be used.

Throws:

CGFileException

saveGraphAsBitmapImage

public static void saveGraphAsBitmapImage(Graph g,
                                          chargerlib.FileFormat format,
                                          File f)

Uses the ImageIO methods to write the graph in the given format This overwrites the file; use chooseViaFileSaveDialog if you need the user to confirm overwriting.

Parameters:

g - the Charger graph to be saved

format - one of the strings returned by ImageIO.getWriterFormatNames()

f - The file in which to save it. Any extension (if any) is replaced by the format string (lower case)

saveGraphAsVectorGraphic

public static void saveGraphAsVectorGraphic(Graph g,
                                            chargerlib.FileFormat format,
                                            String filename)

Uses the ImageIO methods to write the graph in pdf, svg or eps format. This overwrites the file; use chooseViaFileSaveDialog if you need the user to confirm overwriting.

Parameters:

g - the Charger graph to be saved

format - one of the strings returned by

filename - The completely qualified path/file in which to save it. Any extension (if any) is replaced by the format string (lower case)