Class SessionValidator

java.lang.Object

ca.phon.session.check.SessionValidator

All Implemented Interfaces:

IExtendable

public class SessionValidator
extends Object
implements IExtendable

Session validator with plug-in support. This class maintains the list of available validator plug-ins as well as a set of validation listeners.

Constructor Summary

Constructors

Constructor	Description
SessionValidator()
SessionValidator(SessionCheck[] sessionChecks)
SessionValidator(List<SessionCheck> sessionChecks)

Method Summary

Modifier and Type	Method	Description
void	addValidationListener(ValidationListener listener)
void	fireValidationEvent(ValidationEvent evt)
void	fireValidationEvent(ValidationEvent.Severity severity, Session session, int record, Transcriber transcriber, String message)
void	fireValidationEvent(ValidationEvent.Severity severity, Session session, int record, String tierName, Transcriber transcriber, String message)
void	fireValidationEvent(ValidationEvent.Severity severity, Session session, Transcriber transcriber, String message)
void	fireValidationEvent(Session session, int record, Transcriber transcriber, String message)
void	fireValidationEvent(Session session, int record, String tierName, Transcriber transcriber, String message)
void	fireValidationEvent(Session session, Transcriber transcriber, String message)
<T> T	getExtension(Class<T> cap)	Get the requested extension if available.
Set<Class<?>>	getExtensions()	Return all extension types supported
List<ValidationEvent>	getValidationEvents()
List<ValidationListener>	getValidationListeners()
<T> T	putExtension(Class<T> cap, T impl)	Add a new extension.
<T> T	removeExtension(Class<T> cap)	Remove a capability.
void	removeValidationListener(ValidationListener listener)
boolean	validate(Session session, int elementIndex, Transcriber transcriber)	Validate the given transcript element index using all available session checks.
boolean	validate(Session session, Transcriber transcriber)	Validate the given session using all available session checks.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionValidator

public SessionValidator()

SessionValidator

public SessionValidator(SessionCheck[] sessionChecks)

SessionValidator

public SessionValidator(List<SessionCheck> sessionChecks)

Method Details

fireValidationEvent

public void fireValidationEvent(ValidationEvent.Severity severity,
 Session session,
 Transcriber transcriber,
 String message)

fireValidationEvent

public void fireValidationEvent(Session session,
 Transcriber transcriber,
 String message)

fireValidationEvent

public void fireValidationEvent(ValidationEvent.Severity severity,
 Session session,
 int record,
 Transcriber transcriber,
 String message)

fireValidationEvent

public void fireValidationEvent(Session session,
 int record,
 Transcriber transcriber,
 String message)

fireValidationEvent

public void fireValidationEvent(ValidationEvent.Severity severity,
 Session session,
 int record,
 String tierName,
 Transcriber transcriber,
 String message)

fireValidationEvent

public void fireValidationEvent(Session session,
 int record,
 String tierName,
 Transcriber transcriber,
 String message)

fireValidationEvent

public void fireValidationEvent(ValidationEvent evt)

validate

public boolean validate(Session session,
 Transcriber transcriber)

Validate the given session using all available session checks.

Parameters:

session - the session to validate

transcriber - check transcripts for given transcriber, or validated transcripts if validator

Returns:

true if session was modified, false otherwise

validate

public boolean validate(Session session,
 int elementIndex,
 Transcriber transcriber)

Validate the given transcript element index using all available session checks.

Parameters:

session - the session to validate

elementIndex - the transcript element index to validate

transcriber - check transcripts for given transcriber, or validated transcripts if validator

Returns:

true if session was modified, false otherwise

addValidationListener

public void addValidationListener(ValidationListener listener)

removeValidationListener

public void removeValidationListener(ValidationListener listener)

getValidationListeners

public List<ValidationListener> getValidationListeners()

getValidationEvents

public List<ValidationEvent> getValidationEvents()

getExtensions

public Set<Class<?>> getExtensions()

Description copied from interface: IExtendable

Return all extension types supported

Specified by:

getExtensions in interface IExtendable

getExtension

public <T> T getExtension(Class<T> cap)

Description copied from interface: IExtendable

Get the requested extension if available.

Specified by:

getExtension in interface IExtendable

Returns:

the capability object or null if the cability is not available

putExtension

public <T> T putExtension(Class<T> cap,
 T impl)

Description copied from interface: IExtendable

Add a new extension.

Specified by:

putExtension in interface IExtendable

Parameters:

cap - the extension to add

Returns:

the added extension implementation

removeExtension

public <T> T removeExtension(Class<T> cap)

Description copied from interface: IExtendable

Remove a capability.

Specified by:

removeExtension in interface IExtendable

Parameters:

cap - the capability to remove