Glossary
Odd and bespoke terms used in this Javadoc.
- Action
- In this library, specifically means a Struts 2 Action.
- Adjuster
- A kind of of Policy that alters a raw form field value before it's validated or converted. This applies to both single value and collection form fields and is distinct from Post-conversion Adjuster and List Post-conversion Adjuster.
- Auto Conversion
- A method of converting raw request parameters to non-string form fields according to their conversion annotations, retaining failed values as conversion errors.
- Bespoke Policy
- A client written Policy that's paired with a dedicated, client written annotation. Should not be confused with a Custom Policy.
- Built-in Policy
- A Policy that's included in this library. Polices that aren't can be either Bespoke Policies or Custom Policies.
- Classpath Scanning
- Searching the classpath for all classes implementing an interface, which are bespoke policies for this library. This done using ClassGraph.
- Composite Cache
- A set of List Caches where one is the master and the rest are slaves with their lists related to the selected record of the master.
- Converter
- A kind of Policy that converts a raw, String request parameter to the matching single value non-string form field. Only one applies to a field and is run after non-conversion validation and before post-conversion adjusters, if any.
- Conversion Errors
- Request parameter names and values that failed conversion.
- Custom Policy
- A client written Policy where its class is referred by a built-in, custom annotation, such as
CustomConversion, and are typically written on an-hoc basis. Should not be confused with Bespoke Policy. - Default Conversion
- A method of converting raw request parameters to non-string form fields according to default converter of the form fields' type.
- Default Converter
- A kind of Converter used where no annotation is set.
- Find List Action
- A Form Processing Action that constructs a Command to lazy load a list or pages for a List Cache, then redirects to a View List Action to display from the same List Cache.
- Form Processing Action
- A Struts 2 Action that responds to POST requests to edit data or retrieve data into session but not display it.
- Interceptor
- A design pattern where, as part of a framework, code intervenes in an object's lifecycle. Struts 2 makes extensive use of them and runs them before and after an Action executes.
- List Cache
- A client-configured, session-based helper that stores records and Commands for lazy loading in full lists, pages, or detailed single records. A record can be designated as the selected record, which is lazy loaded with details. Usually combined with others in a Composite Cache.
- List Converter
- A kind of of Policy that converts a raw, String request parameter to an array or collection form field. Only one applies to a field and is run after non-conversion validation and before post-conversion adjusters, if any. Despite the name, this can be applied to other types of collection but parameter order may be lost.
- List Post-conversion Adjuster
- A kind of of Policy that alters a converted, array or collection form field value after post-conversion adjuster and before post-conversion validation. Despite the name, this can be applied to other types of collection but any adjusted list order may be lost.
- List Post-conversion Validator
- A kind of of Policy that validates a converted array or collection form field as a whole after post-conversion validation. Despite the name, this can be applied to other types of collection.
- Non-conversion Validator
- A kind of of Policy that validates String form fields, which aren't converted. They are applied after adjusters and before any converter. They can also validate the raw value before its conversion for non-String fields but this is usually pointless (except for the Required validator).
- Pair Conversion
- An older method of converting form fields where one half of a form field pair retained the raw request parameter and the other half retained the converted value.
- Policy
- A design pattern, better known as Strategy, where an algorithm can be loaded from a suite at run-time. In the case of this library, it specifically refers to algorithms for adjusting, converting, and validating form fields.
- Post-conversion Adjuster
- A kind of of Policy that alters a converted, single value form field value after conversion and before post-conversion validation.
- Post-conversion Validator
- A kind of of Policy that validates a converted single value form field after post-conversion adjusters and list post-conversion adjusters.
- Save List Action
- A Form Processing Action that refers to the selected record in a List Cache to modify a database record or otherwise invoke a business function about it. It can accept URL request parameters to modify the List Cache, such as selecting a different record.
- Session per browser tab
- Like standard Java servlet sessions but stores separate user specific data for each browser tab, not for the whole browser.
- View List Action
- A Viewer Action that displays a full list, page or single record in detail from a List Cache. It can accept URL request parameters to modify the List Cache, such as loading a page or selecting a different record.
- Viewer Action
- A Struts 2 Action that responds to GET requests to display data.