uk.ac.ebi.arrayexpress2.magetab.parser

Class AbstractParser<T>

java.lang.Object

uk.ac.ebi.arrayexpress2.magetab.parser.AbstractParser<T>

All Implemented Interfaces:

Parser<T>

Direct Known Subclasses:

ADFParser, IDFParser, MAGETABArrayParser, MAGETABParser, SDRFParser

public abstract class AbstractParser<T>
extends Object
implements Parser<T>

An abstract basic implementation of a Parser. This simply handles progress updating, validator setting and listener registration.

Note that this implementation will cascade any registered listeners to the validator as well. This means that listeners registered to the parser will also report on validation errors, removing the requirement to separately handle parse and validation errors.

Author:

Tony Burdett

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractParser.DefaultHandlerListener

Field Summary

Fields inherited from interface uk.ac.ebi.arrayexpress2.magetab.parser.Parser

DEFAULT_ENCODING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractParser()

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorItemListener(ErrorItemListener listener) Register an ErrorItemListener with this parser.
void	addProgressListener(ProgressListener listener) Register a ProgressListener with this parser.
protected void	fireErrorItemEvent(org.mged.magetab.error.ErrorItem errorItem) Fires an error item notification on any ErrorItemListeners currently configured to listen to this parser.
protected void	fireParseEvent(ProgressEvent event)
protected void	fireParsingCompletedEvent(ProgressEvent event)
protected void	fireParsingFailedEvent(ProgressEvent event)
protected void	fireParsingStartedEvent(ProgressEvent event)
String	getEncoding() Gets current encoding for the parser.
Set<ErrorItemListener>	getErrorItemListeners() Get the collection of ErrorItemListeners registered to this parser
org.slf4j.Logger	getLog()
Collection<ProgressListener>	getProgressListeners() Get the collection of ProgressListeners that are currently registered to this parser.
boolean	isStrippingEscaping()
void	removeErrorItemListener(ErrorItemListener listener) Deregister an ErrorItemListener with this parser.
void	removeProgressListener(ProgressListener listener) Deregister a ProgressListener from this parser.
void	setEncoding(String encoding) Sets an alternative encoding for the parser.
void	setStripEscaping(boolean stripEscaping)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ebi.arrayexpress2.magetab.parser.Parser

parse, parse, parse

Constructor Detail

AbstractParser

protected AbstractParser()

Method Detail

getEncoding

public String getEncoding()

Description copied from interface: Parser

Gets current encoding for the parser.

Specified by:

getEncoding in interface Parser<T>

Returns:

input encoding of the stream

setEncoding

public void setEncoding(String encoding)

Description copied from interface: Parser

Sets an alternative encoding for the parser.

Specified by:

setEncoding in interface Parser<T>

Parameters:

encoding - input encoding of the stream

getLog

public org.slf4j.Logger getLog()

isStrippingEscaping

public boolean isStrippingEscaping()

setStripEscaping

public void setStripEscaping(boolean stripEscaping)

addErrorItemListener

public void addErrorItemListener(ErrorItemListener listener)

Description copied from interface: Parser

Register an ErrorItemListener with this parser. Whenever an error is encountered when parsing from the a parserSource, this listener should be notified.

Specified by:

addErrorItemListener in interface Parser<T>

Parameters:

listener - the listener to register

removeErrorItemListener

public void removeErrorItemListener(ErrorItemListener listener)

Description copied from interface: Parser

Deregister an ErrorItemListener with this parser. This listener will no longer be notified when error items are generated.

Specified by:

removeErrorItemListener in interface Parser<T>

Parameters:

listener - the listener to register

getErrorItemListeners

public Set<ErrorItemListener> getErrorItemListeners()

Description copied from interface: Parser

Get the collection of ErrorItemListeners registered to this parser

Specified by:

getErrorItemListeners in interface Parser<T>

Returns:

the current set of listeners registered

addProgressListener

public void addProgressListener(ProgressListener listener)

Description copied from interface: Parser

Register a ProgressListener with this parser. Whenever the parser has more progress to report, this listener will be notified.

Specified by:

addProgressListener in interface Parser<T>

Parameters:

listener - the listener to register

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Description copied from interface: Parser

Deregister a ProgressListener from this parser. Progress events will no longer be reported through this parser

Specified by:

removeProgressListener in interface Parser<T>

Parameters:

listener - a listener to monitor progress of the parsing operation

getProgressListeners

public Collection<ProgressListener> getProgressListeners()

Description copied from interface: Parser

Get the collection of ProgressListeners that are currently registered to this parser.

Specified by:

getProgressListeners in interface Parser<T>

Returns:

all currently registered progress listeners

fireErrorItemEvent

protected void fireErrorItemEvent(org.mged.magetab.error.ErrorItem errorItem)

Fires an error item notification on any ErrorItemListeners currently configured to listen to this parser.

Parameters:

errorItem - the error item that encapsulates the error

fireParsingStartedEvent

protected void fireParsingStartedEvent(ProgressEvent event)

fireParsingCompletedEvent

protected void fireParsingCompletedEvent(ProgressEvent event)

fireParsingFailedEvent

protected void fireParsingFailedEvent(ProgressEvent event)

fireParseEvent

protected void fireParseEvent(ProgressEvent event)