gate.email

Class EmailDocumentHandler

java.lang.Object

gate.email.EmailDocumentHandler

public class EmailDocumentHandler
extends Object

This class implements the behaviour of the Email reader It takes the Gate Document representing a list with e-mails and creates Gate annotations on it.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<StatusListener>	myStatusListeners

Constructor Summary

Constructors

Constructor and Description
EmailDocumentHandler() Constructor used in tests mostly
EmailDocumentHandler(Document aGateDocument, Map<String,String> aMarkupElementsMap, Map<String,String> anElement2StringMap) Constructor initialises some private fields

Method Summary

Modifier and Type	Method and Description
void	addStatusListener(StatusListener listener) This methos is called when a listener is registered with this class
void	annotateMessages() Reads the Gate Document line by line and does the folowing things: Each line is analized in order to detect where an e-mail starts.
protected boolean	containsSemicolon(String aString) This method checks if a String contains a semicolon char
protected boolean	containsWhiteSpaces(String aString) This method checks if a String contains white spaces.
protected void	fireStatusChangedEvent(String text) This methos is called whenever we need to inform the listener about an event.
protected boolean	hasAMeaning(String aToken) This method tests a token if is Day, Month, Zone, Time, Year
protected boolean	isTime(String aToken) Tests a token if is in time format HH:MM:SS
protected boolean	lineBeginsMessage(String aTextLine) Tests if the line begins an e-mail message
protected boolean	lineBeginsWithField(String aTextLine) Tests if the line begins with a field from the e-mail header If the answer is true then it also sets the member fieldName with the value of this e-mail header field.
void	removeStatusListener(StatusListener listener) This methos is called when a listener is removed

Methods inherited from class java.lang.Object

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

Field Detail

myStatusListeners

protected List<StatusListener> myStatusListeners

Constructor Detail

EmailDocumentHandler

public EmailDocumentHandler()

Constructor used in tests mostly

EmailDocumentHandler

public EmailDocumentHandler(Document aGateDocument,
                            Map<String,String> aMarkupElementsMap,
                            Map<String,String> anElement2StringMap)

Constructor initialises some private fields

Method Detail

annotateMessages

public void annotateMessages()
                      throws IOException,
                             InvalidOffsetException

Reads the Gate Document line by line and does the folowing things:

• Each line is analized in order to detect where an e-mail starts.
• If the line belongs to an e-mail header then creates the annotation if the markupElementsMap allows that.
• Lines belonging to the e-mail body are placed under a Gate annotation called messageBody.

Throws:

IOException

InvalidOffsetException

lineBeginsMessage

protected boolean lineBeginsMessage(String aTextLine)

Tests if the line begins an e-mail message

Parameters:

aTextLine - a line from the file containing the e-mail messages

Returns:

true if the line begins an e-mail message

lineBeginsWithField

protected boolean lineBeginsWithField(String aTextLine)

Tests if the line begins with a field from the e-mail header If the answer is true then it also sets the member fieldName with the value of this e-mail header field.

Parameters:

aTextLine - a line from the file containing the e-mail text

Returns:

true if the line begins with a field from the e-mail header

containsWhiteSpaces

protected boolean containsWhiteSpaces(String aString)

This method checks if a String contains white spaces.

containsSemicolon

protected boolean containsSemicolon(String aString)

This method checks if a String contains a semicolon char

hasAMeaning

protected boolean hasAMeaning(String aToken)

This method tests a token if is Day, Month, Zone, Time, Year

isTime

protected boolean isTime(String aToken)

Tests a token if is in time format HH:MM:SS

addStatusListener

public void addStatusListener(StatusListener listener)

This methos is called when a listener is registered with this class

removeStatusListener

public void removeStatusListener(StatusListener listener)

This methos is called when a listener is removed

fireStatusChangedEvent

protected void fireStatusChangedEvent(String text)

This methos is called whenever we need to inform the listener about an event.