classifierLibrary
Class Symbol

java.lang.Object
  extended byclassifierLibrary.Symbol

public class Symbol
extends java.lang.Object

Library classifierLibrary, Class Symbol

Copyright by Klaus Hufschlag 2004,2005,2006

This file is part of the Generic Classifier Library. The Generic Classifier Library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. The Generic Classifier Library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the Generic Classifier Library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Version:
1.4
Author:
Klaus Hufschlag

Constructor Summary
Symbol(java.lang.String Name)
          Constructor
 
Method Summary
 void addMember(Language m, Symbol s)
          Makes a given Symbol a subordinate of the instance in a given language.
 void addMember(Language m, SymbolSet s)
          Makes a given Set of Symbols a subordinate to the instance in a given language.
 void addMember(Symbol s)
          Makes a given Symbol a subordinate of the instance in the global / default language.
 void addMember(SymbolSet s)
          Makes a given Set of Symbols a subordinate to the instance in the global / default language.
static java.lang.String autoName()
          Generates a valid proposal for a non existing Symbol name.
static Symbol byName(java.lang.String name)
          Returns any Symbol-Instance given his name.
 void debug_out()
           
static Language getAllSymbols()
          Returns a Language of all existing Symbols (i.e. returns the global / default Language).
 java.lang.String getName()
           
 boolean hasMembers()
          Checks the existence of subordinate Symbols in the global / default Language.
 boolean hasMembers(Language s)
          Checks the existence of subordinate Symbols in a given Language.
 boolean subsumes(Language m, Symbol s)
          Checks, wether a given Symbol is a subordinate to the instance in a given Language.
 boolean subsumes(Symbol s)
          Checks, wether a given Symbol is a subordinate to the instance in the global / default Language.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Symbol

public Symbol(java.lang.String Name)
Constructor

Parameters:
Name - Name of the Symbol to create
Method Detail

byName

public static Symbol byName(java.lang.String name)
Returns any Symbol-Instance given his name.

Parameters:
name - Name of Symbol
Returns:
Symbol-Object with given name

autoName

public static java.lang.String autoName()
Generates a valid proposal for a non existing Symbol name.

Returns:
proposal for Symbol-name

getName

public java.lang.String getName()
Returns:
Name

debug_out

public void debug_out()

hasMembers

public boolean hasMembers(Language s)
Checks the existence of subordinate Symbols in a given Language.

Parameters:
s - Language the check refers to.
Returns:
true, if subordinate Symbols exist

hasMembers

public boolean hasMembers()
Checks the existence of subordinate Symbols in the global / default Language.

Returns:
true, if subordinate Symbols exist

addMember

public void addMember(Language m,
                      Symbol s)
Makes a given Symbol a subordinate of the instance in a given language.

Parameters:
m - Language the relation should be defined for
s - Symbol to become subordinate

addMember

public void addMember(Symbol s)
Makes a given Symbol a subordinate of the instance in the global / default language.

Parameters:
s - Symbol to become subordinate

addMember

public void addMember(Language m,
                      SymbolSet s)
Makes a given Set of Symbols a subordinate to the instance in a given language.

Parameters:
m - Language the relation should be defined for
s - SymbolSet of Symbols to become subordinate

addMember

public void addMember(SymbolSet s)
Makes a given Set of Symbols a subordinate to the instance in the global / default language.

Parameters:
s - SymbolSet of Symbols to become subordinate

subsumes

public boolean subsumes(Language m,
                        Symbol s)
Checks, wether a given Symbol is a subordinate to the instance in a given Language.

Parameters:
m - Language in which the relation should be checked.
s - Symbol which is to be checked for being subordinate
Returns:
true, if Symbol s is subordinate to the instance.

subsumes

public boolean subsumes(Symbol s)
Checks, wether a given Symbol is a subordinate to the instance in the global / default Language.

Parameters:
s - Symbol which is to be checked for being subordinate
Returns:
true, if Symbol s is subordinate to the instance.

getAllSymbols

public static Language getAllSymbols()
Returns a Language of all existing Symbols (i.e. returns the global / default Language).

Returns:
Language containing all defined Symbols.