org.ai_heuristic.util

Class SymbolHandler

java.lang.Object

org.ai_heuristic.util.SymbolHandler

public final class SymbolHandler
extends java.lang.Object

This processes symbols for filtering.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANYLETTER
static java.lang.String	ANYNUMBER
static java.lang.String	ANYSYMBOL
static java.lang.String	BS
static java.lang.String	CA
static java.lang.String	CL
static java.lang.String	DQT
static java.lang.String	FIRSTLETTER
static java.lang.String	FIRSTNUMBER
static java.lang.String	FIRSTSPACE
static java.lang.String	FIRSTTAB
static java.lang.String	FS
static java.lang.String	LB
static java.lang.String	LCB
static java.lang.String	LSB
static java.lang.String	NEWLINE List of filter options
static java.lang.String	NL List of symbols
static java.lang.String	NONE
static java.lang.String	P
static java.lang.String	QM
static java.lang.String	QT
static java.lang.String	RB
static java.lang.String	RCB
static java.lang.String	RSB
static java.lang.String	SC
static java.lang.String	SP
static java.lang.String	SPACE
static java.lang.String	T
static java.lang.String	TAB
static java.lang.String	US
static java.lang.String	XMLEE
static java.lang.String	XMLES
static java.lang.String	XMLH
static java.lang.String	XMLQ
static java.lang.String	XMLSE
static java.lang.String	XMLSS

Constructor Summary

Constructors

Constructor and Description
SymbolHandler() Create a new instance of SymbolHandler

Method Summary

Modifier and Type	Method and Description
static java.lang.String	codeSymbol(java.lang.String theSymbol) Code the symbol to give a text-based description, to avoid whitespace errors.
static java.util.ArrayList<java.lang.String>	getFilterCharacters() Get the list of all punctuation symbols that could be used for filtering.
static java.util.ArrayList<java.lang.String>	getFilterGeneralCharacters() Get the list of general types of character to filter over.
static java.util.ArrayList<java.lang.String>	getFilterSymbols() Get the list of symbols that are to be used for filtering.
static java.lang.String	getSymbol(java.lang.String theSymbol) Re-format the symbol representation if currently in coded form.
static java.util.ArrayList<java.lang.String>	getTruncateSymbols() Get the list of symbols that are to be used for filtering.
static boolean	isFilterGeneralCharacter(java.lang.String theTagName) Return true if the entered tag name is a default general character type.
static boolean	singleListSeparatorOK(java.lang.String theSymbol) Return true if the symbol entered can be used as a separator to create a single line list.

Methods inherited from class java.lang.Object

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

Field Detail

NEWLINE

public static final java.lang.String NEWLINE

List of filter options

See Also:

Constant Field Values

TAB

public static final java.lang.String TAB

See Also:

Constant Field Values

SPACE

public static final java.lang.String SPACE

See Also:

Constant Field Values

FIRSTTAB

public static final java.lang.String FIRSTTAB

See Also:

Constant Field Values

FIRSTSPACE

public static final java.lang.String FIRSTSPACE

See Also:

Constant Field Values

FIRSTLETTER

public static final java.lang.String FIRSTLETTER

See Also:

Constant Field Values

FIRSTNUMBER

public static final java.lang.String FIRSTNUMBER

See Also:

Constant Field Values

ANYLETTER

public static final java.lang.String ANYLETTER

See Also:

Constant Field Values

ANYNUMBER

public static final java.lang.String ANYNUMBER

See Also:

Constant Field Values

ANYSYMBOL

public static final java.lang.String ANYSYMBOL

See Also:

Constant Field Values

NONE

public static final java.lang.String NONE

See Also:

Constant Field Values

NL

public static final java.lang.String NL

List of symbols

See Also:

Constant Field Values

T

public static final java.lang.String T

See Also:

Constant Field Values

SP

public static final java.lang.String SP

See Also:

Constant Field Values

P

public static final java.lang.String P

See Also:

Constant Field Values

CA

public static final java.lang.String CA

See Also:

Constant Field Values

SC

public static final java.lang.String SC

See Also:

Constant Field Values

CL

public static final java.lang.String CL

See Also:

Constant Field Values

QM

public static final java.lang.String QM

See Also:

Constant Field Values

US

public static final java.lang.String US

See Also:

Constant Field Values

FS

public static final java.lang.String FS

See Also:

Constant Field Values

BS

public static final java.lang.String BS

See Also:

Constant Field Values

QT

public static final java.lang.String QT

See Also:

Constant Field Values

DQT

public static final java.lang.String DQT

See Also:

Constant Field Values

LB

public static final java.lang.String LB

See Also:

Constant Field Values

RB

public static final java.lang.String RB

See Also:

Constant Field Values

LCB

public static final java.lang.String LCB

See Also:

Constant Field Values

RCB

public static final java.lang.String RCB

See Also:

Constant Field Values

LSB

public static final java.lang.String LSB

See Also:

Constant Field Values

RSB

public static final java.lang.String RSB

See Also:

Constant Field Values

XMLH

public static final java.lang.String XMLH

See Also:

Constant Field Values

XMLQ

public static final java.lang.String XMLQ

See Also:

Constant Field Values

XMLSS

public static final java.lang.String XMLSS

See Also:

Constant Field Values

XMLSE

public static final java.lang.String XMLSE

See Also:

Constant Field Values

XMLES

public static final java.lang.String XMLES

See Also:

Constant Field Values

XMLEE

public static final java.lang.String XMLEE

See Also:

Constant Field Values

Constructor Detail

SymbolHandler

public SymbolHandler()

Create a new instance of SymbolHandler

Method Detail

getSymbol

public static java.lang.String getSymbol(java.lang.String theSymbol)

Re-format the symbol representation if currently in coded form.

Parameters:

theSymbol - the current symbol representation.

Returns:

the symbol to be used for processing.

codeSymbol

public static java.lang.String codeSymbol(java.lang.String theSymbol)

Code the symbol to give a text-based description, to avoid whitespace errors.

Parameters:

theSymbol - the actual symbol value.

Returns:

a text-based description of the symbol.

getFilterSymbols

public static java.util.ArrayList<java.lang.String> getFilterSymbols()

Get the list of symbols that are to be used for filtering.

Returns:

the list of symbols.

getFilterGeneralCharacters

public static java.util.ArrayList<java.lang.String> getFilterGeneralCharacters()

Get the list of general types of character to filter over.

Returns:

the list of general character types.

isFilterGeneralCharacter

public static boolean isFilterGeneralCharacter(java.lang.String theTagName)

Return true if the entered tag name is a default general character type.

Parameters:

theTagName - the tag name to consider.

Returns:

true if a key word representing a default character type

getFilterCharacters

public static java.util.ArrayList<java.lang.String> getFilterCharacters()

Get the list of all punctuation symbols that could be used for filtering.

Returns:

the list of all punctuation symbols.

getTruncateSymbols

public static java.util.ArrayList<java.lang.String> getTruncateSymbols()

Get the list of symbols that are to be used for filtering.

Returns:

the list of symbols.

singleListSeparatorOK

public static boolean singleListSeparatorOK(java.lang.String theSymbol)

Return true if the symbol entered can be used as a separator to create a single line list.

Parameters:

theSymbol - the symbol to use.

Returns:

true if the symbol can be used to separate words to new lines, false otherwise.