A B C D E F G I K L M N O P R S T V W X

A

addField(Attributes) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
A utility function to create a new field from attrib and add it to this input group.
addField(XmlField) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Adds a new field to the fields list and set the parent group of the field to the current group
addGroup(Attributes) - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
An utility method to add a new input group from an xml attribute.
addGroup(XmlGroup) - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Add an input group to the vector and sets the AppData property to this AppData
addRule(Attributes) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
A utility function to create a new input parameter from attrib and add it to this property.
addRule(Rule) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Adds a new rule to the parameter Map and set the parent property of the Rule to this property
alwaysRequired - Variable in class org.apache.fulcrum.intake.model.Field
Is this field always required?
AppData - Class in org.apache.fulcrum.intake.xmlmodel
A class for holding application data structures.
AppData() - Constructor for class org.apache.fulcrum.intake.xmlmodel.AppData
Default Constructor
appendHtmlFormInput(StringBuffer) - Method in class org.apache.fulcrum.intake.model.Group
A xhtml valid hidden input field that notifies intake of the group's presence.
assertValidity(Field) - Method in class org.apache.fulcrum.intake.validator.BigDecimalValidator
Determine whether a field meets the criteria specified in the constraints defined for this validator
assertValidity(String, Locale) - Method in class org.apache.fulcrum.intake.validator.BigDecimalValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in class org.apache.fulcrum.intake.validator.BooleanValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(Field) - Method in class org.apache.fulcrum.intake.validator.DateRangeValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String, Group) - Method in class org.apache.fulcrum.intake.validator.DateRangeValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(Field) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Determine whether a field meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(Field) - Method in class org.apache.fulcrum.intake.validator.DoubleValidator
Determine whether a field meets the criteria specified in the constraints defined for this validator
assertValidity(String, Locale) - Method in class org.apache.fulcrum.intake.validator.DoubleValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(FileItem) - Method in class org.apache.fulcrum.intake.validator.FileValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(Field) - Method in class org.apache.fulcrum.intake.validator.FloatValidator
Determine whether a field meets the criteria specified in the constraints defined for this validator
assertValidity(String, Locale) - Method in class org.apache.fulcrum.intake.validator.FloatValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(Field) - Method in class org.apache.fulcrum.intake.validator.IntegerRangeValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String, Group) - Method in class org.apache.fulcrum.intake.validator.IntegerRangeValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in class org.apache.fulcrum.intake.validator.IntegerValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in class org.apache.fulcrum.intake.validator.LongValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in class org.apache.fulcrum.intake.validator.ShortValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in class org.apache.fulcrum.intake.validator.StringValidator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator
assertValidity(Field) - Method in interface org.apache.fulcrum.intake.validator.Validator
Determine whether a field meets the criteria specified in the constraints defined for this validator
assertValidity(String) - Method in interface org.apache.fulcrum.intake.validator.Validator
Determine whether a testValue meets the criteria specified in the constraints defined for this validator

B

BigDecimalField - Class in org.apache.fulcrum.intake.model
 
BigDecimalField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.BigDecimalField
Constructor.
BigDecimalValidator - Class in org.apache.fulcrum.intake.validator
Validates BigDecimals with the following constraints in addition to those listed in NumberValidator and DefaultValidator.
BigDecimalValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.BigDecimalValidator
Constructor to use when initialising Object
BigDecimalValidator() - Constructor for class org.apache.fulcrum.intake.validator.BigDecimalValidator
Default Constructor
BooleanField - Class in org.apache.fulcrum.intake.model
Processor for boolean fields.
BooleanField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.BooleanField
Constructor.
BooleanValidator - Class in org.apache.fulcrum.intake.validator
Validator for boolean field types.
BooleanValidator() - Constructor for class org.apache.fulcrum.intake.validator.BooleanValidator
Default Constructor
BooleanValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.BooleanValidator
Constructor to use when initialising Object
booleanValue() - Method in class org.apache.fulcrum.intake.model.BooleanField
Gets the boolean value of the field.

C

characters(char[], int, int) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Handles the character data, which we are using to specify the error message.
checkReferences(List, CompareCallback, Object, Group) - Static method in class org.apache.fulcrum.intake.validator.FieldReference
Check the parsed value against the referenced fields
COMPARE_GT - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Integer value for ">" comparison
COMPARE_GTE - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Integer value for ">=" comparison
COMPARE_LT - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Integer value for "<" comparison
COMPARE_LTE - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Integer value for "<=" comparison
CompareCallback - Interface in org.apache.fulcrum.intake.validator
Interface to define the compare operation betwen two field values
compareValues(int, Object, Object) - Method in interface org.apache.fulcrum.intake.validator.CompareCallback
Compare the given values using the compare operation provided
configure(Configuration) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Avalon component lifecycle method
Constraint - Interface in org.apache.fulcrum.intake.validator
A constraint has a name and a value and an optional message.
containsField(XmlField) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Returns true if the input group contains a spesified field
containsField(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Returns true if the input group contains a specified field
contextualize(Context) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
 

D

DateRangeValidator - Class in org.apache.fulcrum.intake.validator
Validates a DateString field in dependency on another DateString field.
DateRangeValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.DateRangeValidator
 
DateRangeValidator() - Constructor for class org.apache.fulcrum.intake.validator.DateRangeValidator
Default constructor
DateStringField - Class in org.apache.fulcrum.intake.model
Field for date inputs as free form text.
DateStringField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.DateStringField
Constructor.
DateStringValidator - Class in org.apache.fulcrum.intake.validator
Validates numbers with the following constraints in addition to those listed in DefaultValidator.
DateStringValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.DateStringValidator
 
DateStringValidator() - Constructor for class org.apache.fulcrum.intake.validator.DateStringValidator
Default Constructor
DEFAULT_POOL_CAPACITY - Static variable in interface org.apache.fulcrum.intake.IntakeService
The default pool capacity.
defaultFieldPackage - Static variable in class org.apache.fulcrum.intake.model.Field
Default Field Package
DefaultValidator - Class in org.apache.fulcrum.intake.validator
DefaultValidator that will compare a testValue against the following constraints: NameValid ValuesDefault Value requiredtrue|falsefalse maskregexp  minLengthinteger0 maxLengthinteger  This validator can serve as the base class for more specific validators
DefaultValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.DefaultValidator
Constructor
DefaultValidator() - Constructor for class org.apache.fulcrum.intake.validator.DefaultValidator
Default constructor
defaultValidatorPackage - Static variable in class org.apache.fulcrum.intake.model.Field
Default Validator Package
defaultValue - Variable in class org.apache.fulcrum.intake.model.Field
Default value of the field
displayName - Variable in class org.apache.fulcrum.intake.model.Field
Display name of the field to be used on data entry forms...
dispose() - Method in class org.apache.fulcrum.intake.model.Field
Disposes the object after use.
doSetValue() - Method in class org.apache.fulcrum.intake.model.BigDecimalField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.BooleanField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.DateStringField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.DoubleField
Sets the value of the field from data in the parser.
doSetValue(ValueParser) - Method in class org.apache.fulcrum.intake.model.Field
Deprecated. Use doSetValue() instead (with no parameters).
doSetValue() - Method in class org.apache.fulcrum.intake.model.Field
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.FileItemField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.FloatField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.IntegerField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.LongField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.ShortField
Sets the value of the field from data in the parser.
doSetValue() - Method in class org.apache.fulcrum.intake.model.StringField
Sets the value of the field from data in the parser.
DoubleField - Class in org.apache.fulcrum.intake.model
Processor for double fields.
DoubleField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.DoubleField
Constructor.
DoubleValidator - Class in org.apache.fulcrum.intake.validator
Validates Doubles with the following constraints in addition to those listed in NumberValidator and DefaultValidator.
DoubleValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.DoubleValidator
Constructor to use when initialising Object
DoubleValidator() - Constructor for class org.apache.fulcrum.intake.validator.DoubleValidator
Default Constructor
DTDResolver - Class in org.apache.fulcrum.intake.transform
A resolver to get the database.dtd file for the XML parser from the jar.
DTDResolver() - Constructor for class org.apache.fulcrum.intake.transform.DTDResolver
constructor

E

EMPTY - Static variable in class org.apache.fulcrum.intake.model.Group
 
emptyValue - Variable in class org.apache.fulcrum.intake.model.Field
Value of the field to use if the mapped parameter is empty or non-existant
enableLogging(Logger) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Provide an Avalon logger
endElement(String, String, String) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Handles closing elements of the xml file.
error(SAXParseException) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Callback function for the xml parser to give errors.
errorMessage - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
Error message pertaining to Rule that was broken

F

fatalError(SAXParseException) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Callback function for the xml parser to give fatalErrors.
Field - Class in org.apache.fulcrum.intake.model
Base class for Intake generated input processing classes.
Field(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.Field
Constructs a field based on data in the xml specification and assigns it to a Group.
FieldFactory - Class in org.apache.fulcrum.intake.model
Creates Field objects.
FieldFactory() - Constructor for class org.apache.fulcrum.intake.model.FieldFactory
 
FieldFactory.FieldCtor - Class in org.apache.fulcrum.intake.model
 
FieldFactory.FieldCtor() - Constructor for class org.apache.fulcrum.intake.model.FieldFactory.FieldCtor
 
FieldReference - Class in org.apache.fulcrum.intake.validator
Helper Class to manage relations between fields.
FieldReference() - Constructor for class org.apache.fulcrum.intake.validator.FieldReference
Constructor
fields - Variable in class org.apache.fulcrum.intake.model.Group
A map of the fields in this group mapped by field name.
fieldsArray - Variable in class org.apache.fulcrum.intake.model.Group
An array of fields in this group.
FileItemField - Class in org.apache.fulcrum.intake.model
 
FileItemField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.FileItemField
Constructor.
FileValidator - Class in org.apache.fulcrum.intake.validator
A validator that will compare a FileItem testValue against the following constraints in addition to those listed in DefaultValidator.
FileValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.FileValidator
Constructor
FileValidator() - Constructor for class org.apache.fulcrum.intake.validator.FileValidator
Default constructor
FLEXIBLE_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"flexible" Rule, used in DateFormat Validator
FloatField - Class in org.apache.fulcrum.intake.model
Processor for float fields.
FloatField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.FloatField
Constructor.
FloatValidator - Class in org.apache.fulcrum.intake.validator
Validates Floats with the following constraints in addition to those listed in NumberValidator and DefaultValidator.
FloatValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.FloatValidator
Constructor to use when initialising Object
FloatValidator() - Constructor for class org.apache.fulcrum.intake.validator.FloatValidator
Default Constructor
format(Date) - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Formats a date into a String.
FORMAT_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"format" Rule, used in DateFormat Validator

G

get(String) - Method in class org.apache.fulcrum.intake.model.Group
Get the Field .
getAppData() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Get the parent of the input group
getBasePackage() - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Get the base package String that will be appended to any mapToObjects
getCompare() - Method in class org.apache.fulcrum.intake.validator.FieldReference
 
getCompareType(String) - Static method in class org.apache.fulcrum.intake.validator.FieldReference
Map the comparison strings to their numeric counterparts
getDateFormatMessage() - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Get the value of minLengthMessage.
getDateFormats() - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Get the value of dateFormats.
getDefault() - Method in class org.apache.fulcrum.intake.model.Field
Loads the default value from the object
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.BigDecimalField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.BooleanField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.DateStringField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.DoubleField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.Field
Produces the fully qualified class name of the default validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.FileItemField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.FloatField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.IntegerField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.LongField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.ShortField
A suitable validator.
getDefaultValidator() - Method in class org.apache.fulcrum.intake.model.StringField
Produces the fully qualified class name of the default validator.
getDefaultValue() - Method in class org.apache.fulcrum.intake.model.Field
Get the default Value
getDefaultValue() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the default Value.
getDisplayName() - Method in class org.apache.fulcrum.intake.model.Field
Get the display name of the field.
getDisplayName() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the display name of the property
getDisplaySize() - Method in class org.apache.fulcrum.intake.model.Field
Gets the diplay size of the field.
getDisplaySize() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Gets the display size of the field.
getEmptyValue() - Method in class org.apache.fulcrum.intake.model.Field
Get the Value to use if the field is empty
getEmptyValue() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the empty Value.
getField() - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Get the parent Field of the rule
getField(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Returns a Specified field.
getFieldClass() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the value of fieldClass.
getFieldGetter(String, String) - Method in interface org.apache.fulcrum.intake.IntakeService
Gets the Method that can be used to get a property value.
getFieldGetter(String, String) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Gets the Method that can be used to get a property value.
getFieldGetter(String, String) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Gets the Method that can be used to get a property value.
getFieldName() - Method in class org.apache.fulcrum.intake.validator.FieldReference
 
getFieldNames() - Method in class org.apache.fulcrum.intake.model.Group
Gets a list of the names of the fields stored in this object.
getFields() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Returns a collection of fields in this input group
getFieldSetter(String, String) - Method in interface org.apache.fulcrum.intake.IntakeService
Gets the Method that can be used to set a property.
getFieldSetter(String, String) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Gets the Method that can be used to set a property.
getFieldSetter(String, String) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Gets the Method that can be used to set a property.
getGID() - Method in class org.apache.fulcrum.intake.model.Group
Get the part of the key used to specify the group.
getGroup(String) - Method in interface org.apache.fulcrum.intake.IntakeService
Gets an instance of a named group either from the pool or by calling the Factory Service if the pool is empty.
getGroup(String) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Gets an instance of a named group either from the pool or by calling the Factory Service if the pool is empty.
getGroup(String) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Gets an instance of a named group either from the pool or by calling the Factory Service if the pool is empty.
getGroup() - Method in class org.apache.fulcrum.intake.model.Field
Returns the Group this field belongs to or null if unknown.
getGroup(String) - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Get a XmlGroup with the given name.
getGroup() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the parent XmlGroup of the property
getGroupKey(String) - Method in interface org.apache.fulcrum.intake.IntakeService
Gets the key (usually a short identifier) for a group.
getGroupKey(String) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Gets the key (usually a short identifier) for a group.
getGroupKey(String) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Gets the key (usually a short identifier) for a group.
getGroupName(String) - Method in interface org.apache.fulcrum.intake.IntakeService
Gets the group name given its key.
getGroupName(String) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Gets the group name given its key.
getGroupName(String) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Gets the group name given its key.
getGroupNames() - Method in interface org.apache.fulcrum.intake.IntakeService
Names of all the defined groups.
getGroupNames() - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Names of all the defined groups.
getGroupNames() - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Names of all the defined groups.
getGroupPrefix() - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Get the prefix String that will be used to qualify intake groups when using multiple XML files
getGroups() - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Return a collection of input sections (<group>).
getHtmlFormInput() - Method in class org.apache.fulcrum.intake.model.Group
A xhtml valid hidden input field that notifies intake of the group's presence.
getHTMLString() - Method in class org.apache.fulcrum.intake.model.Field
Calls toString() on the object returned by getValue(), unless null; and then it returns "", the empty String.
getIfRequiredMessage() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the value of ifRequiredMessage.
getInitialValue() - Method in class org.apache.fulcrum.intake.model.Field
Get the value used as a default.
getInstance(XmlField, Group) - Method in class org.apache.fulcrum.intake.model.FieldFactory.FieldCtor
 
getInstance(XmlField, Group) - Static method in class org.apache.fulcrum.intake.model.FieldFactory
Creates a Field object appropriate for the type specified in the xml file.
getIntakeGroupName() - Method in class org.apache.fulcrum.intake.model.Group
Return the name given to this group.
getKey() - Method in class org.apache.fulcrum.intake.model.Field
Get the key used to identify the field.
getKey() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the parameter key of the property
getKey() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Get the key used to reference this group in input (form)
getLocale() - Method in class org.apache.fulcrum.intake.model.Field
Returns the Locale used when localizing data for this field, or null if unknown.
getMapToObject() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the name of the object that takes this input
getMapToObjects() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
 
getMapToProperty() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the property method that takes this input
getMask() - Method in class org.apache.fulcrum.intake.validator.StringValidator
Get the value of mask.
getMaskMessage() - Method in class org.apache.fulcrum.intake.validator.StringValidator
Get the value of maskMessage.
getMaxLength() - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Get the value of maxLength.
getMaxLengthMessage() - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Get the value of maxLengthMessage.
getMaxSize() - Method in class org.apache.fulcrum.intake.model.Field
Gets the maximum size of the field.
getMaxValue() - Method in class org.apache.fulcrum.intake.validator.BigDecimalValidator
Get the value of maxValue.
getMaxValue() - Method in class org.apache.fulcrum.intake.validator.DoubleValidator
Get the value of maxValue.
getMaxValue() - Method in class org.apache.fulcrum.intake.validator.FloatValidator
Get the value of maxValue.
getMaxValue() - Method in class org.apache.fulcrum.intake.validator.IntegerValidator
Get the value of maxValue.
getMaxValue() - Method in class org.apache.fulcrum.intake.validator.LongValidator
Get the value of maxValue.
getMaxValue() - Method in class org.apache.fulcrum.intake.validator.ShortValidator
Get the value of maxValue.
getMessage() - Method in class org.apache.fulcrum.intake.model.Field
Get any error message resulting from invalid input.
getMessage() - Method in interface org.apache.fulcrum.intake.validator.Constraint
Get the error message.
getMessage() - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Get the error message resulting from invalid input.
getMessage() - Method in class org.apache.fulcrum.intake.validator.FieldReference
 
getMessage() - Method in interface org.apache.fulcrum.intake.validator.Validator
Get the last error message resulting from invalid input.
getMessage() - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Get the error message
getMinLength() - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Get the value of minLength.
getMinLengthMessage() - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Get the value of minLengthMessage.
getMinValue() - Method in class org.apache.fulcrum.intake.validator.BigDecimalValidator
Get the value of minValue.
getMinValue() - Method in class org.apache.fulcrum.intake.validator.DoubleValidator
Get the value of minValue.
getMinValue() - Method in class org.apache.fulcrum.intake.validator.FloatValidator
Get the value of minValue.
getMinValue() - Method in class org.apache.fulcrum.intake.validator.IntegerValidator
Get the value of minValue.
getMinValue() - Method in class org.apache.fulcrum.intake.validator.LongValidator
Get the value of minValue.
getMinValue() - Method in class org.apache.fulcrum.intake.validator.ShortValidator
Get the value of minValue.
getName() - Method in class org.apache.fulcrum.intake.model.Field
Gets the name of the field.
getName() - Method in interface org.apache.fulcrum.intake.validator.Constraint
Get the name of the constraint.
getName() - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Get the name of the parameter
getName() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the name of the property
getName() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Get the name that handles this group
getNumFields() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Utility method to get the number of fields in this input group
getObjectKey() - Method in class org.apache.fulcrum.intake.model.Group
Concatenation of gid and oid.
getObjects(ValueParser) - Method in class org.apache.fulcrum.intake.model.Group
Describe getObjects method here.
getOID() - Method in class org.apache.fulcrum.intake.model.Group
Get the part of the key that distinguishes a group from others of the same name.
getPoolCapacity() - Method in class org.apache.fulcrum.intake.model.Group
Get the number of Group objects that will be pooled.
getPoolCapacity() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
The maximum number of classes specific to this group allowed at one time.
getProperties(Object) - Method in class org.apache.fulcrum.intake.model.Group
Calls getter methods on objects that are known to Intake so that field values in forms can be initialized from the values contained in the intake tool.
getProperty(Object) - Method in class org.apache.fulcrum.intake.model.Field
Loads the valid value from a bean
getQueryKey() - Method in interface org.apache.fulcrum.intake.Retrievable
get an id that differentiates this object from others of its class.
getRawName() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the name of the property
getRequiredMessage() - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Get the value of requiredMessage.
getRuleMap() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
The collection of rules for this field keyed by parameter name.
getRules() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
The collection of rules for this field.
getSafeEmptyValue() - Method in class org.apache.fulcrum.intake.model.BooleanField
Provides access to emptyValue such that the value returned will be acceptable as an argument parameter to Method.invoke.
getSafeEmptyValue() - Method in class org.apache.fulcrum.intake.model.DoubleField
Provides access to emptyValue such that the value returned will be acceptable as an argument parameter to Method.invoke.
getSafeEmptyValue() - Method in class org.apache.fulcrum.intake.model.Field
Provides access to emptyValue such that the value returned will be acceptable as an argument parameter to Method.invoke.
getSafeEmptyValue() - Method in class org.apache.fulcrum.intake.model.FloatField
Provides access to emptyValue such that the value returned will be acceptable as an argument parameter to Method.invoke.
getSafeEmptyValue() - Method in class org.apache.fulcrum.intake.model.IntegerField
Provides access to emptyValue such that the value returned will be acceptable as an argument parameter to Method.invoke.
getSafeEmptyValue() - Method in class org.apache.fulcrum.intake.model.LongField
Provides access to emptyValue such that the value returned will be acceptable as an argument parameter to Method.invoke.
getSafeEmptyValue() - Method in class org.apache.fulcrum.intake.model.ShortField
Provides access to emptyValue such that the value returned will be acceptable as an argument parameter to Method.invoke.
getSize(String) - Method in interface org.apache.fulcrum.intake.IntakeService
Gets the current size of the pool for a named group.
getSize(String) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Gets the current size of the pool for a named group.
getSize(String) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Gets the current size of the pool for a group.
getStringValue() - Method in class org.apache.fulcrum.intake.model.Field
Gets the String representation of the Value.
getter - Variable in class org.apache.fulcrum.intake.model.Field
Getter method in the mapped object used to populate the field
getTestValue() - Method in class org.apache.fulcrum.intake.model.Field
Get the value input by a user that will be validated.
getType() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the type of the property
getValidator() - Method in class org.apache.fulcrum.intake.model.Field
Gets the Validator object for this field.
getValidator() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Get the className of the validator
getValue() - Method in class org.apache.fulcrum.intake.model.Field
Get the value of the field.
getValue() - Method in interface org.apache.fulcrum.intake.validator.Constraint
Get the value of the constraint.
getValue() - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Get the value of the parameter
getValueIfAbsent() - Method in class org.apache.fulcrum.intake.model.Field
Use in a hidden field assign a default value in the event the field is absent from the query parameters.
getVariable() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Deprecated. No replacement
getVariable() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
A String which might be used as a variable of this class
gid - Variable in class org.apache.fulcrum.intake.model.Group
The key used to represent this group in a parameter.
group - Variable in class org.apache.fulcrum.intake.model.Field
Group to which the field belongs
Group - Class in org.apache.fulcrum.intake.model
Holds a group of Fields
Group(XmlGroup) - Constructor for class org.apache.fulcrum.intake.model.Group
Constructs a new Group based on the xml specification.
Group.GroupFactory - Class in org.apache.fulcrum.intake.model
 
Group.GroupFactory(AppData) - Constructor for class org.apache.fulcrum.intake.model.Group.GroupFactory
 

I

ifRequiredMessage - Variable in class org.apache.fulcrum.intake.model.Field
Error message set on the field if required and not set by parser
init(ValueParser) - Method in class org.apache.fulcrum.intake.model.Field
Method called when this field (the group it belongs to) is pulled from the pool.
init(Retrievable) - Method in class org.apache.fulcrum.intake.model.Field
Method called when this field or the group it belongs to is pulled from the pool.
init(ValueParser) - Method in class org.apache.fulcrum.intake.model.FileItemField
Method called when this field (the group it belongs to) is pulled from the pool.
init(ValueParser) - Method in class org.apache.fulcrum.intake.model.Group
Initializes the default Group using parameters.
init(String, ValueParser) - Method in class org.apache.fulcrum.intake.model.Group
Initializes the Group with parameters from RunData corresponding to key.
init(Retrievable) - Method in class org.apache.fulcrum.intake.model.Group
Initializes the group with properties from an object.
init(Map) - Method in class org.apache.fulcrum.intake.validator.BigDecimalValidator
Method to initialise Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.DateRangeValidator
Constructor to use when initialising Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Constructor to use when initialising Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Extract the relevant parameters from the constraints listed in tags within the intake.xml file.
init(Map) - Method in class org.apache.fulcrum.intake.validator.DoubleValidator
Method to initialise Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.FloatValidator
Method to initialise Object
init(Map) - Method in interface org.apache.fulcrum.intake.validator.InitableByConstraintMap
Extract the relevant parameters from the constraints listed in tags within the intake.xml file.
init(Map) - Method in class org.apache.fulcrum.intake.validator.IntegerRangeValidator
Constructor to use when initialising Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.IntegerValidator
Method to initialise Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.LongValidator
Method to initialise Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.ShortValidator
Method to initialise Object
init(Map) - Method in class org.apache.fulcrum.intake.validator.StringValidator
Extract the relevant parameters from the constraints listed in tags within the intake.xml file.
InitableByConstraintMap - Interface in org.apache.fulcrum.intake.validator
This interface marks a bean/class that can have its properties set by values in a Map.
initialize() - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Avalon component lifecycle method Initializes the service by loading default class loaders and customized object factories.
initialized - Variable in class org.apache.fulcrum.intake.model.Field
Has the field has been set from the parser?
IntakeError - Error in org.apache.fulcrum.intake
Base exception thrown by the Intake service.
IntakeError() - Constructor for error org.apache.fulcrum.intake.IntakeError
Constructs a new IntakeError without specified detail message.
IntakeError(String) - Constructor for error org.apache.fulcrum.intake.IntakeError
Constructs a new IntakeError with specified detail message.
IntakeError(Throwable) - Constructor for error org.apache.fulcrum.intake.IntakeError
Constructs a new IntakeError with specified nested Throwable.
IntakeError(String, Throwable) - Constructor for error org.apache.fulcrum.intake.IntakeError
Constructs a new IntakeError with specified detail message and nested Throwable.
IntakeException - Exception in org.apache.fulcrum.intake
Base exception thrown by the Intake service.
IntakeException() - Constructor for exception org.apache.fulcrum.intake.IntakeException
Constructs a new IntakeException without specified detail message.
IntakeException(String) - Constructor for exception org.apache.fulcrum.intake.IntakeException
Constructs a new IntakeException with specified detail message.
IntakeException(Throwable) - Constructor for exception org.apache.fulcrum.intake.IntakeException
Constructs a new IntakeException with specified nested Throwable.
IntakeException(String, Throwable) - Constructor for exception org.apache.fulcrum.intake.IntakeException
Constructs a new IntakeException with specified detail message and nested Throwable.
IntakeRuntimeException - Exception in org.apache.fulcrum.intake
Base runtime exception thrown by the Intake service.
IntakeRuntimeException() - Constructor for exception org.apache.fulcrum.intake.IntakeRuntimeException
Constructs a new IntakeRuntimeException without specified detail message.
IntakeRuntimeException(String) - Constructor for exception org.apache.fulcrum.intake.IntakeRuntimeException
Constructs a new IntakeRuntimeException with specified detail message.
IntakeRuntimeException(Throwable) - Constructor for exception org.apache.fulcrum.intake.IntakeRuntimeException
Constructs a new IntakeRuntimeException with specified nested Throwable.
IntakeRuntimeException(String, Throwable) - Constructor for exception org.apache.fulcrum.intake.IntakeRuntimeException
Constructs a new IntakeRuntimeException with specified detail message and nested Throwable.
IntakeService - Interface in org.apache.fulcrum.intake
This service provides access to input processing objects based on an XML specification.
IntakeServiceFacade - Class in org.apache.fulcrum.intake
This is a Facade class for IntakeService.
IntakeServiceFacade() - Constructor for class org.apache.fulcrum.intake.IntakeServiceFacade
 
IntakeServiceImpl - Class in org.apache.fulcrum.intake
This service provides access to input processing objects based on an XML specification.
IntakeServiceImpl() - Constructor for class org.apache.fulcrum.intake.IntakeServiceImpl
 
IntegerField - Class in org.apache.fulcrum.intake.model
Processor for int fields.
IntegerField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.IntegerField
Constructor.
IntegerRangeValidator - Class in org.apache.fulcrum.intake.validator
Validates an int field in dependency on another int field.
IntegerRangeValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.IntegerRangeValidator
 
IntegerRangeValidator() - Constructor for class org.apache.fulcrum.intake.validator.IntegerRangeValidator
Default constructor
IntegerValidator - Class in org.apache.fulcrum.intake.validator
Validates Integers with the following constraints in addition to those listed in NumberValidator and DefaultValidator.
IntegerValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.IntegerValidator
Constructor to use when initialising Object
IntegerValidator() - Constructor for class org.apache.fulcrum.intake.validator.IntegerValidator
Default Constructor
INVALID_NUMBER_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"invalidNumber" Rule, used in the various Number Validators
InvalidMaskException - Exception in org.apache.fulcrum.intake.validator
An Exception indidate an invalid field mask.
InvalidMaskException(String) - Constructor for exception org.apache.fulcrum.intake.validator.InvalidMaskException
Creates a new InvalidMaskException instance.
InvalidMaskException(String, Throwable) - Constructor for exception org.apache.fulcrum.intake.validator.InvalidMaskException
Creates a new InvalidMaskException instance.
isAllValid() - Method in class org.apache.fulcrum.intake.model.Group
Performs an AND between all the fields in this group.
isDebugEnabled - Variable in class org.apache.fulcrum.intake.model.Field
 
isDeclared - Variable in class org.apache.fulcrum.intake.model.Group
A flag to help prevent duplicate hidden fields declaring this group.
isFlexible() - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Get the value of flexible.
isInitialized() - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Return whether the intake service has been initialized.
isMultiValued - Variable in class org.apache.fulcrum.intake.model.Field
Does this field accept multiple values?
isMultiValued() - Method in class org.apache.fulcrum.intake.model.Field
Flag to determine whether the field has been declared as multi-valued.
isMultiValued() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
can this field have several values?
isRequired() - Method in class org.apache.fulcrum.intake.model.Field
Flag to determine whether the field has been declared as required.
isRequired() - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Get the value of required.
isSet() - Method in class org.apache.fulcrum.intake.model.Field
Flag set to true, if the test value has been set by the parser (even to an empty value, so don't used this to determine if the field contains a non-empty value).
isValid() - Method in class org.apache.fulcrum.intake.model.Field
Flag set to true, if the test value met the constraints.
isValid(Field) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Determine whether a field meets the criteria specified in the constraints defined for this validator
isValid(String) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Deprecated. use isValid(Field) instead
isValid(Field) - Method in interface org.apache.fulcrum.intake.validator.Validator
Determine whether a field meets the criteria specified in the constraints defined for this validator
isValid(String) - Method in interface org.apache.fulcrum.intake.validator.Validator
Deprecated. use isValid(Field) instead
isValidated() - Method in class org.apache.fulcrum.intake.model.Field
Flag to determine whether the field has been validated.

K

key - Variable in class org.apache.fulcrum.intake.model.Field
Key used to identify the field in the parser

L

loadFromXML(Attributes) - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Imports the top level element from an XML specification
loadFromXML(Attributes) - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Imports a column from an XML specification
loadFromXML(Attributes) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Imports a column from an XML specification
loadFromXML(Attributes) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Load the input group object from an xml tag.
log - Variable in class org.apache.fulcrum.intake.model.Field
Logging
log - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
Logging
log - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
a local logger
LongField - Class in org.apache.fulcrum.intake.model
Processor for long fields.
LongField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.LongField
Constructor.
LongValidator - Class in org.apache.fulcrum.intake.validator
Validates Longs with the following constraints in addition to those listed in NumberValidator and DefaultValidator.
LongValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.LongValidator
Constructor to use when initialising Object
LongValidator() - Constructor for class org.apache.fulcrum.intake.validator.LongValidator
Default Constructor

M

makeObject(Object) - Method in class org.apache.fulcrum.intake.model.Group.GroupFactory
Creates an instance that can be returned by the pool.
mapToObject - Variable in class org.apache.fulcrum.intake.model.Field
Class name of the object to which the field is mapped
mapToObjectFields - Variable in class org.apache.fulcrum.intake.model.Group
Map of the fields by mapToObject
MASK_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"mask" Rule, used in StringValidator
maskMessage - Variable in class org.apache.fulcrum.intake.validator.StringValidator
The message to report if the mask constraint is not satisfied
maskPattern - Variable in class org.apache.fulcrum.intake.validator.StringValidator
The compiled Regular Expression
maskString - Variable in class org.apache.fulcrum.intake.validator.StringValidator
The matching mask String as supplied by the XML input
MAX_LENGTH_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"maxLength" Rule, used in all validators
MAX_VALUE_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"maxValue" Rule, used in the various Number Validators
maxLength - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
The maximum length of the field
maxLengthMessage - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
The message to show if field fails max-length test
message - Variable in class org.apache.fulcrum.intake.model.Field
Error message, is any, resulting from validation
MIN_LENGTH_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"minLength" Rule, used in all validators
MIN_VALUE_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"minValue" Rule, used in the various Number Validators
minLength - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
The minimum length of the field
minLengthMessage - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
The message to show if field fails min-length test

N

name - Variable in class org.apache.fulcrum.intake.model.Field
Name of the field.
name - Variable in class org.apache.fulcrum.intake.model.Group
The name used in templates and java code to refer to this group.
NEW - Static variable in class org.apache.fulcrum.intake.model.Group
 

O

oid - Variable in class org.apache.fulcrum.intake.model.Group
The object id used to associate this group to a bean for one request cycle
onError - Variable in class org.apache.fulcrum.intake.model.Field
Value of the field if an error occurs while getting the value from the mapped object
org.apache.fulcrum.intake - package org.apache.fulcrum.intake
The intake service can validate user input from HTML forms.
org.apache.fulcrum.intake.model - package org.apache.fulcrum.intake.model
 
org.apache.fulcrum.intake.transform - package org.apache.fulcrum.intake.transform
 
org.apache.fulcrum.intake.validator - package org.apache.fulcrum.intake.validator
Validators for the various intake field types.
org.apache.fulcrum.intake.xmlmodel - package org.apache.fulcrum.intake.xmlmodel
 

P

parse(String) - Method in class org.apache.fulcrum.intake.validator.BooleanValidator
Parses a srting value into a Boolean object.
parse(String) - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Parses the String s according to the rules/formats for this validator.
parseFile(String) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Parses a XML input file and returns a newly created and populated AppData structure.
parser - Variable in class org.apache.fulcrum.intake.model.Field
The object containing the field data.
passivateObject(Object, Object) - Method in class org.apache.fulcrum.intake.model.Group.GroupFactory
Uninitialize an instance to be returned to the pool.
pp - Variable in class org.apache.fulcrum.intake.model.Group
The object containing the request data

R

RANGE_GT - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Rule name for ">" comparison
RANGE_GTE - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Rule name for ">=" comparison
RANGE_LT - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Rule name for "<" comparison
RANGE_LTE - Static variable in class org.apache.fulcrum.intake.validator.FieldReference
Rule name for "<=" comparison
releaseGroup(Group) - Method in interface org.apache.fulcrum.intake.IntakeService
Puts a group back to the pool.
releaseGroup(Group) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
Puts a group back to the pool.
releaseGroup(Group) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Puts a Group back to the pool.
removeFromRequest() - Method in class org.apache.fulcrum.intake.model.Field
Removes references to this group and its fields from the query parameters
removeFromRequest() - Method in class org.apache.fulcrum.intake.model.Group
Removes references to this group and its fields from the query parameters
required - Variable in class org.apache.fulcrum.intake.model.Field
Does the field require a value?
required - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
A boolean value to signify if the field is definately required or not
REQUIRED_RULE_NAME - Static variable in interface org.apache.fulcrum.intake.validator.Validator
"required" Rule, used in all validators
requiredMessage - Variable in class org.apache.fulcrum.intake.validator.DefaultValidator
The message to show if field fails required test
resetDeclared() - Method in class org.apache.fulcrum.intake.model.Group
To be used in the event this group is used within multiple forms within the same template.
resolveEntity(String, String) - Method in class org.apache.fulcrum.intake.transform.DTDResolver
called by the XML parser
resolveEntity(String, String) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
EntityResolver implementation.
retrievable - Variable in class org.apache.fulcrum.intake.model.Field
Mapped object used to set the initial field value
Retrievable - Interface in org.apache.fulcrum.intake
This interface specifies methods for uniquely identifying an object.
ROLE - Static variable in interface org.apache.fulcrum.intake.IntakeService
Avalon role - used to id the component within the manager
Rule - Class in org.apache.fulcrum.intake.xmlmodel
A Class for holding data about a constraint on a property.
Rule() - Constructor for class org.apache.fulcrum.intake.xmlmodel.Rule
Default Constructor

S

SERIAL_XML - Static variable in interface org.apache.fulcrum.intake.IntakeService
The configuration property specifying the location where a serialized version of the xml specification can be written for faster restarts..
SERIAL_XML_DEFAULT - Static variable in interface org.apache.fulcrum.intake.IntakeService
The default location where a serialized version of the xml specification can be written for faster restarts..
service(ServiceManager) - Method in class org.apache.fulcrum.intake.IntakeServiceImpl
Avalon component lifecycle method
setAppData(AppData) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Set the parent of the group
setBasePackage(String) - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Set the base package String that will be appended to any mapToObjects
setCompare(int) - Method in class org.apache.fulcrum.intake.validator.FieldReference
 
setDateFormatMessage(String) - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Only sets the message if the new message has some information.
setDateFormats(List) - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Set the value of dateFormats.
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.BigDecimalField
Sets the default value for a BigDecimal field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.BooleanField
Sets the default value for a Boolean field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.DateStringField
Sets the default value for a DateString field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.DoubleField
Sets the default value for a Double Field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.Field
Set the default Value.
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.FileItemField
It is not possible to set the default value for this field type.
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.FloatField
Sets the default value for an Float Field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.IntegerField
Sets the default value for an Integer Field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.LongField
Sets the default value for an Long Field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.ShortField
Sets the default value for an Short Field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.model.StringField
Sets the default value for a String field
setDefaultValue(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the default Value.
setDisplayName(String) - Method in class org.apache.fulcrum.intake.model.Field
Set the display name of the field.
setDisplayName(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the display name of the property
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.BigDecimalField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.BooleanField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.DateStringField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.DoubleField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.Field
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.FileItemField
It is not possible to set the empty value for this field type.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.FloatField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.IntegerField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.LongField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.ShortField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.model.StringField
Set the empty Value.
setEmptyValue(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the empty Value.
setField(XmlField) - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Set the parent Field of the rule
setFieldClass(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the value of fieldClass.
setFieldName(String) - Method in class org.apache.fulcrum.intake.validator.FieldReference
 
setFlag - Variable in class org.apache.fulcrum.intake.model.Field
Has the field has been set from the parser?
setFlexible(boolean) - Method in class org.apache.fulcrum.intake.validator.DateStringValidator
Set the value of flexible.
setGroup(XmlGroup) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the parent XmlGroup of the property
setGroupPrefix(String) - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Set the prefix String that will be used to qualify intake groups when using multiple XML files
setIfRequiredMessage(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the value of ifRequiredMessage.
setIntakeService(IntakeService) - Static method in class org.apache.fulcrum.intake.IntakeServiceFacade
 
setKey(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the parameter key of the property
setKey(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Set the key used to reference this group in input (form)
setMapToObject(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the name of the object that takes this input
setMapToProperty(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the property method that takes this input
setMask(String) - Method in class org.apache.fulcrum.intake.validator.StringValidator
Set the value of mask.
setMaskMessage(String) - Method in class org.apache.fulcrum.intake.validator.StringValidator
Set the value of maskMessage.
setMaxLength(int) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Set the value of maxLength.
setMaxLengthMessage(String) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Set the value of maxLengthMessage.
setMaxValue(BigDecimal) - Method in class org.apache.fulcrum.intake.validator.BigDecimalValidator
Set the value of maxValue.
setMaxValue(double) - Method in class org.apache.fulcrum.intake.validator.DoubleValidator
Set the value of maxValue.
setMaxValue(float) - Method in class org.apache.fulcrum.intake.validator.FloatValidator
Set the value of maxValue.
setMaxValue(int) - Method in class org.apache.fulcrum.intake.validator.IntegerValidator
Set the value of maxValue.
setMaxValue(long) - Method in class org.apache.fulcrum.intake.validator.LongValidator
Set the value of maxValue.
setMaxValue(short) - Method in class org.apache.fulcrum.intake.validator.ShortValidator
Set the value of maxValue.
setMessage(String) - Method in class org.apache.fulcrum.intake.model.Field
Sets an error message.
setMessage(String) - Method in class org.apache.fulcrum.intake.validator.FieldReference
 
setMessage(String) - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Set the error message
setMinLength(int) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Set the value of minLength.
setMinLengthMessage(String) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Set the value of minLengthMessage.
setMinValue(BigDecimal) - Method in class org.apache.fulcrum.intake.validator.BigDecimalValidator
Set the value of minValue.
setMinValue(double) - Method in class org.apache.fulcrum.intake.validator.DoubleValidator
Set the value of minValue.
setMinValue(float) - Method in class org.apache.fulcrum.intake.validator.FloatValidator
Set the value of minValue.
setMinValue(int) - Method in class org.apache.fulcrum.intake.validator.IntegerValidator
Set the value of minValue.
setMinValue(long) - Method in class org.apache.fulcrum.intake.validator.LongValidator
Set the value of minValue.
setMinValue(short) - Method in class org.apache.fulcrum.intake.validator.ShortValidator
Set the value of minValue.
setMultiValued(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set whether this class can have multiple values
setName(String) - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Set the name of the parameter
setName(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the name of the property
setName(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Set the name that handles this group
setProperties(Object) - Method in class org.apache.fulcrum.intake.model.Group
Calls a setter methods on obj, for fields which have been set.
setProperty(Object) - Method in class org.apache.fulcrum.intake.model.Field
Calls a setter method on obj, if this field has been set.
setQueryKey(String) - Method in interface org.apache.fulcrum.intake.Retrievable
set an id that differentiates this object from others of its class.
setRequired(boolean) - Method in class org.apache.fulcrum.intake.model.Field
Set whether this field is required to have a value.
setRequired(boolean, String) - Method in class org.apache.fulcrum.intake.model.Field
Set the value of required.
setRequired(boolean, String) - Method in class org.apache.fulcrum.intake.model.StringField
Set the value of required.
setRequired(boolean) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Set the value of required.
setRequiredMessage(String) - Method in class org.apache.fulcrum.intake.validator.DefaultValidator
Set the value of requiredMessage.
setter - Variable in class org.apache.fulcrum.intake.model.Field
Setter method in the mapped object used to store the value of field
setType(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the type of the property
setValidator(String) - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
Set the class name of the validator
setValidProperties(Object) - Method in class org.apache.fulcrum.intake.model.Group
Calls a setter methods on obj, for fields which pass validity tests.
setValue(String) - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
Set the value of the parameter
ShortField - Class in org.apache.fulcrum.intake.model
Processor for short fields.
ShortField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.ShortField
Constructor.
ShortValidator - Class in org.apache.fulcrum.intake.validator
Validates Shorts with the following constraints in addition to those listed in NumberValidator and DefaultValidator.
ShortValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.ShortValidator
Constructor to use when initialising Object
ShortValidator() - Constructor for class org.apache.fulcrum.intake.validator.ShortValidator
Default Constructor
startElement(String, String, String, Attributes) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Handles opening elements of the xml file.
StringField - Class in org.apache.fulcrum.intake.model
Text field.
StringField(XmlField, Group) - Constructor for class org.apache.fulcrum.intake.model.StringField
Constructor.
StringValidator - Class in org.apache.fulcrum.intake.validator
A validator that will compare a testValue against the following constraints: NameValid ValuesDefault Value requiredtrue|falsefalse maskregexp  minLengthinteger0 maxLengthinteger  This validator can serve as the base class for more specific validators
StringValidator(Map) - Constructor for class org.apache.fulcrum.intake.validator.StringValidator
Constructor
StringValidator() - Constructor for class org.apache.fulcrum.intake.validator.StringValidator
Default constructor

T

toString() - Method in class org.apache.fulcrum.intake.model.DateStringField
returns a String representation
toString() - Method in class org.apache.fulcrum.intake.model.Field
Calls toString() on the object returned by getValue(), unless null; and then it returns "", the empty String.
toString() - Method in class org.apache.fulcrum.intake.xmlmodel.AppData
Creats a string representation of this AppData.
toString() - Method in class org.apache.fulcrum.intake.xmlmodel.Rule
String representation of the column.
toString() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlField
String representation of the column.
toString() - Method in class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Creates a string representation of this input group.

V

validate(ValueParser) - Method in class org.apache.fulcrum.intake.model.Field
Deprecated. Call validate() instead (with no parameters).
validate() - Method in class org.apache.fulcrum.intake.model.Field
Compares request data with constraints and sets the valid flag.
validate() - Method in class org.apache.fulcrum.intake.model.FileItemField
Compares request data with constraints and sets the valid flag.
validated - Variable in class org.apache.fulcrum.intake.model.Field
Has the field been validated?
ValidationException - Exception in org.apache.fulcrum.intake.validator
An Exception to mark a failed validation
ValidationException(String) - Constructor for exception org.apache.fulcrum.intake.validator.ValidationException
Creates a new ValidationException instance.
validator - Variable in class org.apache.fulcrum.intake.model.Field
Used to validate the contents of the field
Validator - Interface in org.apache.fulcrum.intake.validator
Validator api.
validFlag - Variable in class org.apache.fulcrum.intake.model.Field
Has the field passed the validation test?

W

warning(SAXParseException) - Method in class org.apache.fulcrum.intake.transform.XmlToAppData
Callback function for the xml parser to give warnings.

X

XML_PATH_DEFAULT - Static variable in interface org.apache.fulcrum.intake.IntakeService
The default location of the xml specification.
XML_PATHS - Static variable in interface org.apache.fulcrum.intake.IntakeService
The configuration property specifying the location of the xml specification.
XmlField - Class in org.apache.fulcrum.intake.xmlmodel
A Class for holding data about a property used in an Application.
XmlField() - Constructor for class org.apache.fulcrum.intake.xmlmodel.XmlField
Default Constructor
XmlField(String) - Constructor for class org.apache.fulcrum.intake.xmlmodel.XmlField
Creates a new column and set the name
XmlGroup - Class in org.apache.fulcrum.intake.xmlmodel
A Class for holding data about a grouping of inputs used in an Application.
XmlGroup() - Constructor for class org.apache.fulcrum.intake.xmlmodel.XmlGroup
Constructs a input group object
XmlToAppData - Class in org.apache.fulcrum.intake.transform
A Class that is used to parse an input xml schema file and creates and AppData java structure.
XmlToAppData() - Constructor for class org.apache.fulcrum.intake.transform.XmlToAppData
Creates a new instance of the Intake XML Parser

A B C D E F G I K L M N O P R S T V W X

Copyright © 2005-2009 The Apache Software Foundation. All Rights Reserved.