gate.creole.morph
Class CharacterSet

java.lang.Object
  gate.creole.morph.Variable
      gate.creole.morph.CharacterSet

public class CharacterSet
extends Variable

Title:

Description:

Copyright: Copyright (c) 2003

Company:

Version:

1.0

Author:

not attributable

Field Summary

Fields inherited from class gate.creole.morph.Variable

pointer, varName, varValue

Constructor Summary

CharacterSet()
Constructor

Method Summary

boolean	contains(String value) A method that tells if the characters of the provided value are from the characterSet only
boolean	hasNext() Tells if any value available which can be retrieved
String	next() Returns the next available value for this variable
boolean	set(String varName, String varValue) Process the provided value and stores in the underlying data structure

Methods inherited from class gate.creole.morph.Variable

getPattern, resetPointer

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterSet

public CharacterSet()

Constructor

Method Detail

hasNext

public boolean hasNext()

Tells if any value available which can be retrieved

Specified by:

hasNext in class Variable

Returns:

true if value available, false otherwise

next

public String next()

Returns the next available value for this variable

Specified by:

next in class Variable

Returns:

value of the variable in the String format

set

public boolean set(String varName,
                   String varValue)

Process the provided value and stores in the underlying data structure

Specified by:

set in class Variable

Parameters:

varName - name of the variable

varValue - String that contains possible different values

Returns:

true if successfully stored, false otherwise

contains

public boolean contains(String value)

A method that tells if the characters of the provided value are from the characterSet only

Specified by:

contains in class Variable

Parameters:

value - String of which the characters to be searched in the characterSet

Returns:

true if all characters of value string are from the specified characterSet, false otherwise