InspectionResultConstants (Metawidget API Documentation)

java.lang.Object
- org.metawidget.inspector.InspectionResultConstants

```
public final class InspectionResultConstants
extends Object
```
Common element and attribute names appearing in DOMs conforming to inspection-result-1.0.xsd.
Metawidget promotes a loose coupling between Inspectors and widget creation. In particular, it discourages any single Inspector dictating an XML attribute name, as that Inspector then holds a 'monopoly' on how that attribute gets initialised (eg. it should not matter whether a required attribute came from a JPA annotation, a Hibernate mapping file or Hibernate Validator).
Metawidget also promotes that, as both Inspectors and widget creation evolve independently, the XML attributes recognized should evolve in an 'ad hoc' fashion: Metawidget places no restrictions on what attribute names can be used.
However, for those attribute names that have become sufficiently standardized, it is desirable to have a more formalized 'middle ground', if only to avoid typos.

Author:

Richard Kennard

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION`
`static String`	`COMES_AFTER`
`static String`	`CURRENCY_CODE` ISO 4217 currency code to be applied when formatting currencies.
`static String`	`CURRENCY_SYMBOL`
`static String`	`DATE_STYLE`
`static String`	`DATETIME_PATTERN`
`static String`	`DATETIME_TYPE`
`static String`	`DISABLED` Disabled field attribute.
`static String`	`DONT_EXPAND` Don't expand field attribute.
`static String`	`ENTITY`
`static String`	`FALSE` When a true/false attribute is false.
`static String`	`HIDDEN` Hidden field attribute.
`static String`	`INVERSE_RELATIONSHIP` The field in a child entity that relates back to us (i.e.
`static String`	`LABEL` Label field attribute.
`static String`	`LARGE` Field is a 'large' field, such as a BLOB or a CLOB.
`static String`	`LOCALE`
`static String`	`LOOKUP` Possible field values are to be looked up through the given set of Strings.
`static String`	`LOOKUP_HAS_EMPTY_CHOICE` Force the lookup to have an empty choice in cases where it would normally be suppressed (eg.
`static String`	`LOOKUP_LABELS` Possible field values are to be presented as the given set of Strings.
`static String`	`MASKED` Masked field attribute.
`static String`	`MAXIMUM_FRACTIONAL_DIGITS` The maximum number of fractional digits in this field.
`static String`	`MAXIMUM_INTEGER_DIGITS` The maximum number of integer digits in this field.
`static String`	`MAXIMUM_LENGTH` The maximum length of this field (eg.
`static String`	`MAXIMUM_VALUE` The maximum value this field can contain.
`static String`	`MINIMUM_FRACTIONAL_DIGITS` The minimum number of fractional digits in this field.
`static String`	`MINIMUM_INTEGER_DIGITS` The minimum number of integer digits in this field.
`static String`	`MINIMUM_LENGTH` The minimum length of this field (eg.
`static String`	`MINIMUM_VALUE` The minimum value this field can contain.
`static String`	`NAME` Name attribute.
`static String`	`NAMESPACE`
`static String`	`NO_SETTER` Whether the property has no setter method.
`static String`	`NUMBER_PATTERN`
`static String`	`NUMBER_TYPE` The type of the number, such as 'currency' or 'percentage'.
`static String`	`NUMBER_USES_GROUPING_SEPARATORS` Whether the formatted output should contain grouping separators (eg.
`static String`	`PARAMETERIZED_TYPE` Parameterized type arguments, for example the type of elements in a Set.
`static String`	`PROPERTY`
`static String`	`READ_ONLY` Read-only field attribute.
`static String`	`REQUIRED` Required field attribute.
`static String`	`ROOT`
`static String`	`SECTION`
`static String`	`TIME_STYLE`
`static String`	`TIME_ZONE`
`static String`	`TRUE` When a true/false attribute is true.
`static String`	`TYPE` Type attribute.
`static String`	`VALIDATION_PATTERN` Regular expression pattern specified by validation library.
`static String`	`VERSION`
`static String`	`WIDE` Field is a 'wide' field, spanning all columns in a multi-column layout.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    Constant Field Values
  - ROOT
```
public static final String ROOT
```
    See Also:
    Constant Field Values
  - VERSION
```
public static final String VERSION
```
    See Also:
    Constant Field Values
  - ENTITY
```
public static final String ENTITY
```
    See Also:
    Constant Field Values
  - PROPERTY
```
public static final String PROPERTY
```
    See Also:
    Constant Field Values
  - ACTION
```
public static final String ACTION
```
    See Also:
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Name attribute.
    Name is the only guide to behaviour when Metawidget is merging DOM trees from multiple Inspectors. No other attributes, element tag names or document structure are considered. For this reason, all names within any branch of the DOM-subtree must be unique.
    
    See Also:
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    Type attribute.
    For Java classes, this should be the fully-qualified, instantiatable class name (for example, it should not have <K,V> or <String> generic arguments appended to it)
    For more abstract concepts, this can be any unique identifier (eg. 'Login Screen').
    
    See Also:
    Constant Field Values
  - COMES_AFTER
```
public static final String COMES_AFTER
```
    See Also:
    Constant Field Values
  - PARAMETERIZED_TYPE
```
public static final String PARAMETERIZED_TYPE
```
    Parameterized type arguments, for example the type of elements in a Set.
    Often this comes from generics, but it can come from other sources (eg. Hibernate mapping files, UiAttribute annotations).
    
    See Also:
    Constant Field Values
  - READ_ONLY
```
public static final String READ_ONLY
```
    Read-only field attribute.
    
    See Also:
    Constant Field Values
  - NO_SETTER
```
public static final String NO_SETTER
```
    Whether the property has no setter method.
    Properties without setters are not automatically considered READ_ONLY. If the property is a complex type (eg. Address), it may be writable by setting each of its nested primitives (eg. Street, City, etc) even though in itself it is 'not settable'.
    
    See Also:
    Constant Field Values
  - REQUIRED
```
public static final String REQUIRED
```
    Required field attribute.
    Can be set by, say, org.hibernate.validator.NotNull or javax.persistence.Column( nullable = false ).
    
    See Also:
    Constant Field Values
  - DISABLED
```
public static final String DISABLED
```
    Disabled field attribute.
    
    See Also:
    Constant Field Values
  - HIDDEN
```
public static final String HIDDEN
```
    Hidden field attribute.
    Even though a field is 'hidden' from the user, it may still be a necessary part of the User Interface, and must therefore be part of the inspection result. For example, HTML metawidgets may need to render hidden fields using input type="hidden" tags.
    Also, it is not possible for an Inspector to hide a field by simply not returning it, as other Inspectors in the chain (who are not concerned with a 'hidden' attribute) will add it back in.
    
    See Also:
    Constant Field Values
  - LOOKUP
```
public static final String LOOKUP
```
    Possible field values are to be looked up through the given set of Strings.
    
    See Also:
    Constant Field Values
  - LOOKUP_LABELS
```
public static final String LOOKUP_LABELS
```
    Possible field values are to be presented as the given set of Strings.
    
    See Also:
    Constant Field Values
  - LOOKUP_HAS_EMPTY_CHOICE
```
public static final String LOOKUP_HAS_EMPTY_CHOICE
```
    Force the lookup to have an empty choice in cases where it would normally be suppressed (eg. on primitive or required fields)
    
    See Also:
    Constant Field Values
  - MASKED
```
public static final String MASKED
```
    Masked field attribute.
    Whether the field is 'masked' (eg. a password field). Expected values are true or false. Note this attribute does not denote 'masked' as in a date format or a number format.
    
    See Also:
    Constant Field Values
  - LABEL
```
public static final String LABEL
```
    Label field attribute.
    
    See Also:
    Constant Field Values
  - SECTION
```
public static final String SECTION
```
    See Also:
    Constant Field Values
  - LARGE
```
public static final String LARGE
```
    Field is a 'large' field, such as a BLOB or a CLOB.
    
    See Also:
    Constant Field Values
  - WIDE
```
public static final String WIDE
```
    Field is a 'wide' field, spanning all columns in a multi-column layout.
    Wide is different to 'large', because 'large' implies a data size (ie. BLOB or CLOB) whereas 'wide' refers purely to spanning columns. Generally all 'large' fields are implicitly 'wide', but not all 'wide' fields are 'large'. For example, you may want a normal text field (not a text area) to span all columns.
    
    See Also:
    Constant Field Values
  - MINIMUM_VALUE
```
public static final String MINIMUM_VALUE
```
    The minimum value this field can contain. May be a floating point number.
    
    See Also:
    Constant Field Values
  - MAXIMUM_VALUE
```
public static final String MAXIMUM_VALUE
```
    The maximum value this field can contain. May be a floating point number.
    
    See Also:
    Constant Field Values
  - MINIMUM_LENGTH
```
public static final String MINIMUM_LENGTH
```
    The minimum length of this field (eg. number of characters)
    
    See Also:
    Constant Field Values
  - MAXIMUM_LENGTH
```
public static final String MAXIMUM_LENGTH
```
    The maximum length of this field (eg. number of characters).
    Can be set by, say, org.hibernate.validator.Length or javax.persistence.Column( length ).
    
    See Also:
    Constant Field Values
  - MINIMUM_INTEGER_DIGITS
```
public static final String MINIMUM_INTEGER_DIGITS
```
    The minimum number of integer digits in this field.
    
    See Also:
    Constant Field Values
  - MAXIMUM_INTEGER_DIGITS
```
public static final String MAXIMUM_INTEGER_DIGITS
```
    The maximum number of integer digits in this field.
    
    See Also:
    Constant Field Values
  - MINIMUM_FRACTIONAL_DIGITS
```
public static final String MINIMUM_FRACTIONAL_DIGITS
```
    The minimum number of fractional digits in this field.
    
    See Also:
    Constant Field Values
  - MAXIMUM_FRACTIONAL_DIGITS
```
public static final String MAXIMUM_FRACTIONAL_DIGITS
```
    The maximum number of fractional digits in this field.
    
    See Also:
    Constant Field Values
  - DONT_EXPAND
```
public static final String DONT_EXPAND
```
    Don't expand field attribute.
    
    See Also:
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    When a true/false attribute is true.
    This stops ambiguity around using 'true', 't', 'yes', etc.
    
    See Also:
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    When a true/false attribute is false.
    
    See Also:
    Constant Field Values
  - INVERSE_RELATIONSHIP
```
public static final String INVERSE_RELATIONSHIP
```
    The field in a child entity that relates back to us (i.e. JPA's mappedBy).
    
    See Also:
    Constant Field Values
  - CURRENCY_CODE
```
public static final String CURRENCY_CODE
```
    ISO 4217 currency code to be applied when formatting currencies.
    
    See Also:
    Constant Field Values
  - CURRENCY_SYMBOL
```
public static final String CURRENCY_SYMBOL
```
    See Also:
    Constant Field Values
  - NUMBER_USES_GROUPING_SEPARATORS
```
public static final String NUMBER_USES_GROUPING_SEPARATORS
```
    Whether the formatted output should contain grouping separators (eg. commas).
    
    See Also:
    Constant Field Values
  - LOCALE
```
public static final String LOCALE
```
    See Also:
    Constant Field Values
  - NUMBER_PATTERN
```
public static final String NUMBER_PATTERN
```
    See Also:
    Constant Field Values
  - NUMBER_TYPE
```
public static final String NUMBER_TYPE
```
    The type of the number, such as 'currency' or 'percentage'.
    
    See Also:
    Constant Field Values
  - DATE_STYLE
```
public static final String DATE_STYLE
```
    See Also:
    Constant Field Values
  - TIME_STYLE
```
public static final String TIME_STYLE
```
    See Also:
    Constant Field Values
  - DATETIME_PATTERN
```
public static final String DATETIME_PATTERN
```
    See Also:
    Constant Field Values
  - TIME_ZONE
```
public static final String TIME_ZONE
```
    See Also:
    Constant Field Values
  - DATETIME_TYPE
```
public static final String DATETIME_TYPE
```
    See Also:
    Constant Field Values
  - VALIDATION_PATTERN
```
public static final String VALIDATION_PATTERN
```
    Regular expression pattern specified by validation library.
    
    See Also:
    Constant Field Values

Class InspectionResultConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

ROOT

VERSION

ENTITY

PROPERTY

ACTION

NAME

TYPE

COMES_AFTER

PARAMETERIZED_TYPE

READ_ONLY

NO_SETTER

REQUIRED

DISABLED

HIDDEN

LOOKUP

LOOKUP_LABELS

LOOKUP_HAS_EMPTY_CHOICE

MASKED

LABEL

SECTION

LARGE

WIDE

MINIMUM_VALUE

MAXIMUM_VALUE

MINIMUM_LENGTH

MAXIMUM_LENGTH

MINIMUM_INTEGER_DIGITS

MAXIMUM_INTEGER_DIGITS

MINIMUM_FRACTIONAL_DIGITS

MAXIMUM_FRACTIONAL_DIGITS

DONT_EXPAND

TRUE

FALSE

INVERSE_RELATIONSHIP

CURRENCY_CODE

CURRENCY_SYMBOL

NUMBER_USES_GROUPING_SEPARATORS

LOCALE

NUMBER_PATTERN

NUMBER_TYPE

DATE_STYLE

TIME_STYLE

DATETIME_PATTERN

TIME_ZONE

DATETIME_TYPE

VALIDATION_PATTERN