Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.field

Class MetisFieldValidation

java.lang.Object

io.github.tonywasher.joceanus.metis.field.MetisFieldValidation

All Implemented Interfaces:

MetisDataItem.MetisDataObjectFormat, MetisFieldItem

public class MetisFieldValidation
extends Object
implements MetisFieldItem

Records errors relating to an item.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetisFieldValidation.MetisFieldError	represents an instance of an error for an object.

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldUpdatableItem, MetisFieldItem.MetisFieldVersionedDef

Constructor Summary

Constructors

Constructor	Description
MetisFieldValidation()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addError(String pText, MetisDataItem.MetisDataFieldId pField)	add error to the list.
void	clearErrors()	Clear errors.
void	endErrors(StringBuilder pErrors)	End error text.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
String	getFieldErrors(MetisDataItem.MetisDataFieldId pField)	Get the error details for a particular field.
String	getFieldErrors(MetisFieldItem.MetisFieldDef[] aFields)	Get the error text for fields outside a set of fields.
MetisFieldValidation.MetisFieldError	getFirst()	Get the first error in the list.
boolean	hasErrors()	Do we have any errors?
boolean	hasErrors(MetisDataItem.MetisDataFieldId pField)	Determine whether there are any errors for a particular field.

Methods inherited from class java.lang.Object

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

Constructor Details

MetisFieldValidation

public MetisFieldValidation()

Constructor.

Method Details

getDataFieldSet

public MetisFieldItem.MetisFieldSetDef getDataFieldSet()

Description copied from interface: MetisFieldItem

Obtain the fieldSet.

Specified by:

getDataFieldSet in interface MetisFieldItem

Returns:

the fieldSet

formatObject

public String formatObject(OceanusDataFormatter pFormatter)

Description copied from interface: MetisDataItem.MetisDataObjectFormat

Obtain Object summary.

Specified by:

formatObject in interface MetisDataItem.MetisDataObjectFormat

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

hasErrors

public boolean hasErrors()

Do we have any errors?

Returns:

true/false

getFirst

public MetisFieldValidation.MetisFieldError getFirst()

Get the first error in the list.

Returns:

the first error or null

addError

public void addError(String pText,
 MetisDataItem.MetisDataFieldId pField)

add error to the list.

Parameters:

pText - the text for the error

pField - the field for the error

hasErrors

public boolean hasErrors(MetisDataItem.MetisDataFieldId pField)

Determine whether there are any errors for a particular field.

Parameters:

pField - - the field

Returns:

true if there are any errors false otherwise

getFieldErrors

public String getFieldErrors(MetisDataItem.MetisDataFieldId pField)

Get the error details for a particular field.

Parameters:

pField - - the field

Returns:

the error text

getFieldErrors

public String getFieldErrors(MetisFieldItem.MetisFieldDef[] aFields)

Get the error text for fields outside a set of fields.

Parameters:

aFields - the set of fields

Returns:

the error text

endErrors

public void endErrors(StringBuilder pErrors)

End error text.

Parameters:

pErrors - the error builder

clearErrors

public void clearErrors()

Clear errors.