cgif.generate

Class NameGenerator

Object

cgif.generate.NameGenerator

public class NameGenerator
extends Object

This class is used to generate unique referent label names for a conceptual graph. * @author Harry S. Delugach ( delugach@uah.edu ) Copyright 1998-2020

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BASE_NAME Base name used for the label names
private Set<String>	nameSet Set to store all the label names that have been used
private long	nextDigit Next digit to concatenate with the base name to generate a new label name.

Constructor Summary

Constructors

Constructor and Description
NameGenerator() Default constructor that creates a new name generator with an empty set of used names.
NameGenerator(Graph graph) Creates a new name generator with the names from the specified graph excluded as possible names to generate.

Method Summary

Modifier and Type	Method and Description
void	addName(String name) Adds the specified name to the set of names to excluded when generating label names.
void	addNames(Graph graph) Adds the defining and bound label names from the specified graph to the list of names to exclude when generating new names.
void	clear() Clears the set of names that have been used so far and resets the name generation sequence.
String	generateName() Generates and returns a label name that has not been used.
Set<String>	getNames() Returns a copy of the set of names that have been generated or manually added to the exclusion set.
boolean	isGenericName(String name) Looks for several cases: is the name null, the empty string, a single "*" or a set referent with *
boolean	isUseableName(String name) Returns true if the specified name is a label name that has not been generated and hasn't been manually added to the set of names to exclude.

Methods inherited from class Object

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

Field Detail

BASE_NAME

private static final String BASE_NAME

Base name used for the label names

See Also:

Constant Field Values

nextDigit

private long nextDigit

Next digit to concatenate with the base name to generate a new label name. This should always be positive.

nameSet

private Set<String> nameSet

Set to store all the label names that have been used

Constructor Detail

NameGenerator

public NameGenerator()

Default constructor that creates a new name generator with an empty set of used names.

NameGenerator

public NameGenerator(Graph graph)

Creates a new name generator with the names from the specified graph excluded as possible names to generate.

Parameters:

graph - All the label names from the graph are added as to the set of names to exclude.

Method Detail

addName

public void addName(String name)

Adds the specified name to the set of names to excluded when generating label names.

Parameters:

name - Name to add to the exclusion set

addNames

public void addNames(Graph graph)

Adds the defining and bound label names from the specified graph to the list of names to exclude when generating new names.

Parameters:

graph - Graph to traverse to look for label names

isUseableName

public boolean isUseableName(String name)

Returns true if the specified name is a label name that has not been generated and hasn't been manually added to the set of names to exclude.

Parameters:

name - Name to test

Returns:

Returns true if the name hasn't been used

isGenericName

public boolean isGenericName(String name)

Looks for several cases: is the name null, the empty string, a single "*" or a set referent with *

Parameters:

name -

Returns:

clear

public void clear()

Clears the set of names that have been used so far and resets the name generation sequence.

getNames

public Set<String> getNames()

Returns a copy of the set of names that have been generated or manually added to the exclusion set.

Returns:

Returns the set of names that have been used

generateName

public String generateName()

Generates and returns a label name that has not been used. Only the name is returned, not any symbols that need to precede it for CGIF. The generated name is added to the internal set of names not to be used again.

Returns:

Returns a label name that has not been used