cgif.generate

Class CGIFWriter

Object

cgif.generate.CGIFWriter

public class CGIFWriter
extends Object

This class can be used to convert conceptual graphs in the CharGer format into the standard CGIF file format based on ISO/IEC 24707:2007(E). * @author Harry S. Delugach ( delugach@uah.edu ) Copyright 1998-2020

Field Summary

Fields

Modifier and Type	Field and Description
private String	indent This string represents the indention applied to inner subcontexts
private NameGenerator	nameGenerator Used to generate unique label names for concepts in the graph that do not contain constants.
private HashMap<GraphObjectID,String>	nameTable Table mapping GraphObject objectID's to defining/bound label names
private PrintStream	stream Output stream to which to write the conceptual graphs
private boolean	writeComments Flag specifying if comments should be written when generating CGIF

Constructor Summary

Constructors

Constructor and Description
CGIFWriter(OutputStream out) Creates a CGIFWriter that can write conceptual graphs in CGIF format to the specified output stream using a default sub-context indention of four whitespaces.
CGIFWriter(OutputStream out, String indent) Creates a CGIFWriter that can write conceptual graphs in CGIF format to the specified output stream using the specified sub-context indention.
CGIFWriter(OutputStream out, String indent, boolean writeComments) Creates a CGIFWriter that can write conceptual graphs in CGIF format to the specified output stream using the specified sub-context indention.

Method Summary

Modifier and Type	Method and Description
protected void	addCorefLinks(Concept concept, String corefName) Adds coreference name entries for the specified concept and all the linked concept to the corefNameTable.
protected String	generateComment(GraphObject go) Returns a string representation of the comment for the specified object.
String	getIndention() Returns the string representing the indention applied to the beginning of each new subcontext.
static String	graphToString(Graph graph) Converts the specified graph into a string representation of the standard CGIF format without comments.
static String	graphToString(Graph graph, boolean writeComments) Converts the specified graph into a string representation of the standard CGIF format.
protected static boolean	needsQuote(String s) Examines a string and if it contains all "normal" characters, don't quote it.
protected static String	quotify(String s) Delimit a string with double quotes, and escape (via substituting \u0022 for double quote) any double quotes in the string.
protected static String	quotifyWithPrefix(String s)
void	setIndention(String indent) Sets the string to be applied to the beginning of each new subcontext.
protected void	sortInputEdges(List<GEdge> edges) This sorts the specified input edges.
void	write(Graph graph) Writes the specified graph to the output stream of this class using the standard CGIF format.
protected void	write(Graph graph, String currIndent) Writes the specified graph to the output stream of this class using the standard CGIF format.
static void	write(OutputStream out, Graph graph) Writes the specified graph to the specified output stream using the standard CGIF format without comments.
static void	write(OutputStream out, Graph graph, boolean writeComments) Writes the specified graph to the specified output stream using the standard CGIF format.
protected void	writeConcepts(List<Concept> concepts, String currIndent) Writes the specified concepts to the output stream of this class using the standard CGIF format.
protected void	writeGenSpecLinks(List<GenSpecLink> genspeclinks, String currIndent) Write the generalization-specialization links, with all the types on one line and all the subtype relations on a second line, in accordance with Dr.
protected <T> void	writeLinkingNodes(List<? extends GNode> nodes, String currIndent) Writes the specified nodes that link concepts (Actor or Relation) to the output stream of this class using the standard CGIF format.
static void	writeToFile(String filename, Graph graph) Writes the specified graph to a file with the specified filename using the standard CGIF format without comments.
static void	writeToFile(String filename, Graph graph, boolean writeComments) Writes the specified graph to a file with the specified filename using the standard CGIF format.

Methods inherited from class Object

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

Field Detail

nameGenerator

private NameGenerator nameGenerator

Used to generate unique label names for concepts in the graph that do not contain constants.

nameTable

private HashMap<GraphObjectID,String> nameTable

Table mapping GraphObject objectID's to defining/bound label names

stream

private PrintStream stream

Output stream to which to write the conceptual graphs

indent

private String indent

This string represents the indention applied to inner subcontexts

writeComments

private boolean writeComments

Flag specifying if comments should be written when generating CGIF

Constructor Detail

CGIFWriter

public CGIFWriter(OutputStream out)

Creates a CGIFWriter that can write conceptual graphs in CGIF format to the specified output stream using a default sub-context indention of four whitespaces.

Parameters:

out - Output stream to which to write the conceptual graphs

CGIFWriter

public CGIFWriter(OutputStream out,
                  String indent)

Creates a CGIFWriter that can write conceptual graphs in CGIF format to the specified output stream using the specified sub-context indention.

Parameters:

out - Output stream to which to write the conceptual graphs

indent - Indention applied to each sub-context

CGIFWriter

public CGIFWriter(OutputStream out,
                  String indent,
                  boolean writeComments)

Creates a CGIFWriter that can write conceptual graphs in CGIF format to the specified output stream using the specified sub-context indention.

Parameters:

out - Output stream to which to write the conceptual graphs

indent - Indention applied to each sub-context

writeComments - Flag specifying if comments should be written

Method Detail

write

public static void write(OutputStream out,
                         Graph graph)

Writes the specified graph to the specified output stream using the standard CGIF format without comments.

Parameters:

out - Output stream to which to write the graph

graph - Graph to convert and write out

write

public static void write(OutputStream out,
                         Graph graph,
                         boolean writeComments)

Writes the specified graph to the specified output stream using the standard CGIF format.

Parameters:

out - Output stream to which to write the graph

graph - Graph to convert and write out

writeComments - Flag specifying if comments should be written

writeToFile

public static void writeToFile(String filename,
                               Graph graph)
                        throws FileNotFoundException,
                               IOException

Writes the specified graph to a file with the specified filename using the standard CGIF format without comments.

Parameters:

filename - Name of the file to which to write the graph

graph - Graph to convert and write out

Throws:

FileNotFoundException, - IOException

FileNotFoundException

IOException

writeToFile

public static void writeToFile(String filename,
                               Graph graph,
                               boolean writeComments)
                        throws FileNotFoundException,
                               IOException

Writes the specified graph to a file with the specified filename using the standard CGIF format.

Parameters:

filename - Name of the file to which to write the graph

graph - Graph to convert and write out

writeComments - Flag specifying if comments should be written

Throws:

FileNotFoundException, - IOException

FileNotFoundException

IOException

graphToString

public static String graphToString(Graph graph)

Converts the specified graph into a string representation of the standard CGIF format without comments.

Parameters:

graph - Graph to convert to a string

Returns:

Returns a string representation of the graph in CGIF format

graphToString

public static String graphToString(Graph graph,
                                   boolean writeComments)

Converts the specified graph into a string representation of the standard CGIF format.

Parameters:

graph - Graph to convert to a string

writeComments - Flag specifying if comments should be written

Returns:

Returns a string representation of the graph in CGIF format

getIndention

public String getIndention()

Returns the string representing the indention applied to the beginning of each new subcontext.

Returns:

Returns the subcontext indention

setIndention

public void setIndention(String indent)

Sets the string to be applied to the beginning of each new subcontext.

Parameters:

indent - Indention string to be applied to each subcontext

write

public void write(Graph graph)

Writes the specified graph to the output stream of this class using the standard CGIF format.

Parameters:

graph - Graph to convert and write out

write

protected void write(Graph graph,
                     String currIndent)

Writes the specified graph to the output stream of this class using the standard CGIF format. The core CGIF format is given preference over the extended CGIF format where possible.

Parameters:

graph - Graph to convert and write out

currIndent - Indention for each line for the current context

writeGenSpecLinks

protected void writeGenSpecLinks(List<GenSpecLink> genspeclinks,
                                 String currIndent)

Write the generalization-specialization links, with all the types on one line and all the subtype relations on a second line, in accordance with Dr. Simon Polovina's requirements.

Parameters:

genspeclinks -

currIndent -

writeConcepts

protected void writeConcepts(List<Concept> concepts,
                             String currIndent)

Writes the specified concepts to the output stream of this class using the standard CGIF format. The core CGIF format is given preference over the extended CGIF format where possible.

Parameters:

concepts - List of concepts to print

currIndent - Indention for each line for the current context

writeLinkingNodes

protected <T> void writeLinkingNodes(List<? extends GNode> nodes,
                                     String currIndent)

Writes the specified nodes that link concepts (Actor or Relation) to the output stream of this class using the standard CGIF format. The core CGIF format is given preference over the extended CGIF format where possible.

Parameters:

nodes - List of Actors or Relations

currIndent - Indention for each line for the current context

addCorefLinks

protected void addCorefLinks(Concept concept,
                             String corefName)

Adds coreference name entries for the specified concept and all the linked concept to the corefNameTable.

Parameters:

concept - Concept to add

corefName - Name of the coreference link without any special CGIF characters

sortInputEdges

protected void sortInputEdges(List<GEdge> edges)

This sorts the specified input edges. It first attempts to sort them by assuming they all have numeric labels. If any don't have numeric labels, then it sorts them by object ID's.

Parameters:

edges - Edges to be sorted

generateComment

protected String generateComment(GraphObject go)

Returns a string representation of the comment for the specified object. The comment is the created by converting the graph object to XML and removing unncessary spacing and lines.

Parameters:

go - GraphObject of which to generate a comment

Returns:

Returns the XML string for the object in CGIF comment format

quotify

protected static String quotify(String s)

Delimit a string with double quotes, and escape (via substituting \u0022 for double quote) any double quotes in the string. See https://www.fileformat.info/info/unicode/char/0022/index.htm for a description of this character.

Parameters:

s -

Returns:

a quoted string with double quotes replaced by \u0022. All other characters are preserved.

quotifyWithPrefix

protected static String quotifyWithPrefix(String s)

needsQuote

protected static boolean needsQuote(String s)

Examines a string and if it contains all "normal" characters, don't quote it.

Parameters:

s -

Returns:

true if anything other than alphanumeric characters are present.