buri.ddmsence.ddms

Class ValidationMessage

Object

buri.ddmsence.ddms.ValidationMessage

public class ValidationMessage
extends Object

Simple class representing a validation message.

DDMS components are validated during instantiation, and a component is either valid or does not exist. These messages are either embedded in a thrown InvalidDDMSException (in which case they are errors), or stored as informational messages on the component itself (warnings).

The locator string provides additional information about the context of the error or warning. This string is implemented as an XPath string right now: if the error was coming from a ddms:identifier component, the locator would be "/ddms:identifier". Should a parent component choose to report the warnings/errors of a child component, the locator string could be expanded with parent information, such as "/ddms:resource/ddms:identifier".

Please note that the XPath string is not intended to drill all the way down to the offending element or attribute. It should merely provide enough context so that the source of the message can be discovered.

Since:

0.9.c

Author:

Brian Uri!

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_PREFIX XPath prefix to separate elements
static String	ERROR_TYPE Constant type for an error.
static String	WARNING_TYPE Constant type for a warning.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLocator() Accessor for the locator
String	getText() Accessor for the text
String	getType() Accessor for the type
int	hashCode()
static ValidationMessage	newError(String text, String locator) Factory method to create an error
static ValidationMessage	newWarning(String text, String locator) Factory method to create a warning
void	setLocator(String locator) Accessor for the locator.
String	toString()

Methods inherited from class Object

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

Field Detail

WARNING_TYPE

public static final String WARNING_TYPE

Constant type for a warning.

See Also:

Constant Field Values

ERROR_TYPE

public static final String ERROR_TYPE

Constant type for an error.

See Also:

Constant Field Values

ELEMENT_PREFIX

public static final String ELEMENT_PREFIX

XPath prefix to separate elements

See Also:

Constant Field Values

Method Detail

newWarning

public static ValidationMessage newWarning(String text,
                                           String locator)

Factory method to create a warning

Parameters:

text - the description text

locator - a locator string, in XPath format. For attributes, use empty string. The parent element will claim the attributes.

Returns:

a new warning message

newError

public static ValidationMessage newError(String text,
                                         String locator)

Factory method to create an error

Parameters:

text - the description text

locator - a locator string, in XPath format. For attributes, use empty string. The parent element will claim the attributes.

Returns:

a new error message

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getType

public String getType()

Accessor for the type

getText

public String getText()

Accessor for the text

getLocator

public String getLocator()

Accessor for the locator

setLocator

public void setLocator(String locator)

Accessor for the locator.

If the locator is null, it will be set to an empty string. If not, it will be prefixed with a forward-slash.