org.fopps.model
Class ConstraintViolation

java.lang.Object
  |
  +--org.fopps.model.ConstraintViolation

public class ConstraintViolation

extends java.lang.Object

ConstraintViolation represents an error entry of a constraint. A typical constraint violation is a loop in the constraint sequence.

Author:

Oliver Wieland

Field Summary

static int	ERROR
static int	WARNING

Constructor Summary

ConstraintViolation(int value, java.lang.String message)
Creates a new violation entry without given sources.

ConstraintViolation(int severity, java.lang.String message, AbstractItem first, AbstractItem second)
Creates a new violation entry with given sources.

ConstraintViolation(java.lang.String message)
Creates a new violation entry without given sources and WARNING severity.

ConstraintViolation(java.lang.String message, AbstractItem first, AbstractItem second)
Creates a new violation entry with given sources.

Method Summary

AbstractItem	getFirst()
java.lang.String	getMessage() Returns a description of the violation
AbstractItem	getSecond()
int	getSeverity() Returns the severity of the violation.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

WARNING

public static final int WARNING

See Also:

Constant Field Values

ERROR

public static final int ERROR

See Also:

Constant Field Values

Constructor Detail

ConstraintViolation

public ConstraintViolation(int severity,
                           java.lang.String message,
                           AbstractItem first,
                           AbstractItem second)

Creates a new violation entry with given sources.

Parameters:

severity - Severity of the violation

message - Violation message (a brief description)

first - First source of the violation

second - Second source of the violation

ConstraintViolation

public ConstraintViolation(java.lang.String message,
                           AbstractItem first,
                           AbstractItem second)

Creates a new violation entry with given sources. Severity is set to WARNING

Parameters:

message - Violation message (a brief description)

first - First source of the violation

second - Second source of the violation

ConstraintViolation

public ConstraintViolation(int value,
                           java.lang.String message)

Creates a new violation entry without given sources.

Parameters:

message - Violation message (a brief description)

ConstraintViolation

public ConstraintViolation(java.lang.String message)

Creates a new violation entry without given sources and WARNING severity.

Parameters:

message - Violation message (a brief description)

Method Detail

getSeverity

public int getSeverity()

Returns the severity of the violation. Severity 'ERROR' means, that this violation will cause problems in configuration. WARNING indicates a possible problem.

Returns:

Severity of violation

getMessage

public java.lang.String getMessage()

Returns a description of the violation

Returns:

Violation description

getFirst

public AbstractItem getFirst()

getSecond

public AbstractItem getSecond()

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the severity of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.