Package uk.ac.ebi.pride.jmztab2.utils.errors

Class MZTabErrorType

java.lang.Object

uk.ac.ebi.pride.jmztab2.utils.errors.MZTabErrorType

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CrossCheckErrorType, FormatErrorType, LogicalErrorType

public class MZTabErrorType
extends java.lang.Object
implements java.io.Serializable

MZTabErrorType class.

Since:

28/01/13

Author:

qingwei

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MZTabErrorType.Category
static class	MZTabErrorType.Level	We classify diagnosis message types into three levels: Info, Warn and Error, all of them coming from the notational conventions of the specification.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MZTabErrorType()	Constructor for MZTabErrorType.

Method Summary

Modifier and Type	Method	Description
protected static MZTabErrorType	createError(MZTabErrorType.Category category, java.lang.String keyword)	Generate a MZTabErrorType.Level.Error by parse keyword.
protected static MZTabErrorType	createInfo(MZTabErrorType.Category category, java.lang.String keyword)	Generate a MZTabErrorType.Level.Info by parse keyword.
protected static MZTabErrorType	createWarn(MZTabErrorType.Category category, java.lang.String keyword)	Generate a MZTabErrorType.Level.Warn by parse keyword.
boolean	equals(java.lang.Object obj)
static MZTabErrorType.Level	findLevel(java.lang.String target)	findLevel.
static MZTabErrorType	forLevel(MZTabErrorType.Category category, MZTabErrorType.Level level, java.lang.String keyword)
MZTabErrorType.Category	getCategory()	Getter for the field category.
java.lang.String	getCause()	Getter for the field cause.
java.lang.Integer	getCode()	Getter for the field code.
MZTabErrorType.Level	getLevel()	Getter for the field level.
java.lang.String	getOriginal()	Getter for the field original.
int	hashCode()
java.lang.String	toString()	Code: Unique number for error/warn Category: Currently, there are three types of messages: Format, Logical Original: Message expression pattern. "{?}"

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MZTabErrorType

protected MZTabErrorType()

Constructor for MZTabErrorType.

Method Detail

forLevel

public static MZTabErrorType forLevel(MZTabErrorType.Category category,
                                      MZTabErrorType.Level level,
                                      java.lang.String keyword)

createError

protected static MZTabErrorType createError(MZTabErrorType.Category category,
                                            java.lang.String keyword)

Generate a MZTabErrorType.Level.Error by parse keyword.

Parameters:

category - a MZTabErrorType.Category object.

keyword - a String object.

Returns:

a MZTabErrorType object.

createWarn

protected static MZTabErrorType createWarn(MZTabErrorType.Category category,
                                           java.lang.String keyword)

Generate a MZTabErrorType.Level.Warn by parse keyword.

Parameters:

category - a MZTabErrorType.Category object.

keyword - a String object.

Returns:

a MZTabErrorType object.

createInfo

protected static MZTabErrorType createInfo(MZTabErrorType.Category category,
                                           java.lang.String keyword)

Generate a MZTabErrorType.Level.Info by parse keyword.

Parameters:

category - a MZTabErrorType.Category object.

keyword - a String object.

Returns:

a MZTabErrorType object.

getCode

public java.lang.Integer getCode()

Getter for the field code.

Returns:

a Integer object.

getCategory

public MZTabErrorType.Category getCategory()

Getter for the field category.

Returns:

a MZTabErrorType.Category object.

getLevel

public MZTabErrorType.Level getLevel()

Getter for the field level.

Returns:

a MZTabErrorType.Level object.

getOriginal

public java.lang.String getOriginal()

Getter for the field original.

Returns:

a String object.

getCause

public java.lang.String getCause()

Getter for the field cause.

Returns:

a String object.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Code: Unique number for error/warn Category: Currently, there are three types of messages: Format, Logical Original: Message expression pattern. "{?}" is a couple of parameters which can be filled during validate processing. Cause: A readable text to describe the reason why raise this error/warn. Currently, these cause message coming from mztab specification mainly.

Overrides:

toString in class java.lang.Object

Returns:

a String object.

findLevel

public static MZTabErrorType.Level findLevel(java.lang.String target)

findLevel.

Parameters:

target - a String object.

Returns:

the MZTabErrorType.Level