Class ValidationEvent

java.lang.Object

ca.phon.session.check.ValidationEvent

All Implemented Interfaces:

IExtendable

public class ValidationEvent
extends Object
implements IExtendable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ValidationEvent.Severity

Constructor Summary

Constructors

Constructor	Description
ValidationEvent(ValidationEvent.Severity severity, Session session, int elementIndex, Transcriber transcriber, String message)
ValidationEvent(ValidationEvent.Severity severity, Session session, int elementIndex, Transcriber transcriber, String message, SessionQuickFix... quickFixes)
ValidationEvent(ValidationEvent.Severity severity, Session session, int elementIndex, String tierName, Transcriber transcriber, String message, SessionQuickFix... quickFixes)
ValidationEvent(ValidationEvent.Severity severity, Session session, Transcriber transcriber, String message)
ValidationEvent(ValidationEvent.Severity severity, Session session, Transcriber transcriber, String message, SessionQuickFix... quickFixes)
ValidationEvent(Session session, int elementIndex, Transcriber transcriber, String message)
ValidationEvent(Session session, int elementIndex, Transcriber transcriber, String message, SessionQuickFix... quickFixes)
ValidationEvent(Session session, int elementIndex, String tierName, Transcriber transcriber, String message)
ValidationEvent(Session session, int elementIndex, String tierName, Transcriber transcriber, String message, SessionQuickFix... quickFixes)
ValidationEvent(Session session, Transcriber transcriber, String message)
ValidationEvent(Session session, Transcriber transcriber, String message, SessionQuickFix... quickFixes)

Method Summary

Modifier and Type	Method	Description
boolean	canFix()	Can this event be automatically fixed? Sub-classes should override this method.
int	getElementIndex()
<T> T	getExtension(Class<T> cap)	Get the requested extension if available.
Set<Class<?>>	getExtensions()	Return all extension types supported
String	getMessage()
List<SessionQuickFix>	getQuickFixes()	Options for fixing the problem identified by this validation event.
Session	getSession()
ValidationEvent.Severity	getSeverity()
String	getTierName()
Transcriber	getTranscriber()
<T> T	putExtension(Class<T> cap, T impl)	Add a new extension.
<T> T	removeExtension(Class<T> cap)	Remove a capability.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ValidationEvent

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

ValidationEvent

public ValidationEvent(Session session,
 Transcriber transcriber,
 String message)

ValidationEvent

public ValidationEvent(ValidationEvent.Severity severity,
 Session session,
 Transcriber transcriber,
 String message,
 SessionQuickFix... quickFixes)

ValidationEvent

public ValidationEvent(Session session,
 Transcriber transcriber,
 String message,
 SessionQuickFix... quickFixes)

ValidationEvent

public ValidationEvent(ValidationEvent.Severity severity,
 Session session,
 int elementIndex,
 Transcriber transcriber,
 String message)

ValidationEvent

public ValidationEvent(Session session,
 int elementIndex,
 Transcriber transcriber,
 String message)

ValidationEvent

public ValidationEvent(ValidationEvent.Severity severity,
 Session session,
 int elementIndex,
 Transcriber transcriber,
 String message,
 SessionQuickFix... quickFixes)

ValidationEvent

public ValidationEvent(Session session,
 int elementIndex,
 Transcriber transcriber,
 String message,
 SessionQuickFix... quickFixes)

ValidationEvent

public ValidationEvent(Session session,
 int elementIndex,
 String tierName,
 Transcriber transcriber,
 String message)

ValidationEvent

public ValidationEvent(Session session,
 int elementIndex,
 String tierName,
 Transcriber transcriber,
 String message,
 SessionQuickFix... quickFixes)

ValidationEvent

public ValidationEvent(ValidationEvent.Severity severity,
 Session session,
 int elementIndex,
 String tierName,
 Transcriber transcriber,
 String message,
 SessionQuickFix... quickFixes)

Method Details

getTranscriber

public Transcriber getTranscriber()

getSeverity

public ValidationEvent.Severity getSeverity()

getSession

public Session getSession()

getElementIndex

public int getElementIndex()

getTierName

public String getTierName()

getMessage

public String getMessage()

canFix

public boolean canFix()

Can this event be automatically fixed? Sub-classes should override this method.

Returns:

can the validation event be fixed

getQuickFixes

public List<SessionQuickFix> getQuickFixes()

Options for fixing the problem identified by this validation event.

Returns:

a list of validation options or an empty list if this problem does not have a quick fix

toString

public String toString()

Overrides:

toString in class Object

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