Namespace: OpenEdge.BusinessLogic.Filter
Class
FilterParserBuilder
Parent classes:
Inherits: OpenEdge.Core.Util.ConfigBuilder

/* *************************************************************************************************************************
Copyright (c) 2018 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:FilterParserBuilder
Purpose:Contains a registry of objects used to parse JSON or other (typically)
string-based filters and create strongly-typed objects
Author(s):pjudge
Created:2018-08-05
/* (mandatory) The filter pattern for which we create the Parser




Method Summary
Options Name Purpose
LOGICAL AppendArrayCharacterValue (character, character) /** Appends a character value to an array (convenience) @param character The option name @param character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.BusinessLogic.Filter.FilterParserBuilder Build (character) /* Returns a parser builder for a give filter pattern. @param character The filter pattern name @return FilterParserBuilder A builder for a parser for that pattern. */
OpenEdge.BusinessLogic.Filter.FilterParserBuilder Build (JsonArray) /* Builds a parser for a JSON filter. This array version loops through the array and passes any OBJECT or STRING entries to the relevant Build() method. @param JsonArray The entire filter @return FilterParserBuilder The filter parser builder to use */
OpenEdge.BusinessLogic.Filter.FilterParserBuilder Build (JsonObject) /* Builds a parser for a JSON filter Specialised JSON filter parsers are used. To figure out which on to use 1. Look for a string property called mappingType and use that property value 2. Loop for a property in the JSON that matches one of the registered filter parsers. 3. Return without raising error. @param JsonObject The entire filter @return FilterParserBuilder The filter parser builder to use */
OpenEdge.BusinessLogic.Filter.FilterParser BuildParser () /* Builds a parser for a JSON filter @param character The name of the parser to find @return FilterParser A usable parser, if one exists. May return NULL */
ClearOptions () /** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL FindConfigRecord (buffer, character) /** Internal helper method to perform the find. This method attempts to find a record using the input buffer. @param buffer The buffer of the ConfigOption table. @param character The config name @return logical True if a config record was found. */
Inherited from OpenEdge.Core.Util.ConfigBuilder
DATETIME-TZ GetOptionDateTimeValue (character) /** Returns an option's datetime value @param character The option name @return datetime-tz the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL GetOptionLogicalValue (character) /** Returns an option's logical value @param character The option name @return logical the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LONGCHAR GetOptionLongcharValue (character) /** Returns an option's longchar value @param character The option name @return longchar the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
DECIMAL GetOptionNumericValue (character) /** Returns an option's decimal value @param character The option name @return decimal the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
Object GetOptionObjectValue (character) /** Returns an option's object value @param character The option name @return Object the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringArrayValue (character) /** Returns an option's character array value @param character The option name @return character[] the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringValue (character) /** Returns an option's character value @param character The option name @return character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL HasOption (character) /** Checks whether a config option already exists @param character The option name @return logical True if the named configuration option exists */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL RemoveOption (character) /** Removes an option @param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, character) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, character[]) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, datetime-tz) /** Stores a datetime-tzvalue as an option @param character The option name @param datetime-tz the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, decimal) /** Stores an numeric value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, logical) /** Stores a logical value as an option @param character The option name @param logical the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, Object) /** Stores an object value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (Class, Object) /** Stores an object value as an option @param Progress.Lang>Class The option name (as a type) @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.BusinessLogic.Filter.FilterParserBuilder TableName (character) /* Sets the table for which this filter applies, if any @param character A table name for this filter @return FilterParserBuilder this object */
OpenEdge.BusinessLogic.Filter.FilterParserBuilder TableName (character[]) /* Sets the table for which this filter applies, if any @param character[] Table names for this filter @return FilterParserBuilder this object */

Constructor Summary
Options Name Purpose
FilterParserBuilder (character) /* Constructor @param character The filter type that we're constructing a parser for */

Property Summary
Options Name Purpose
CHARACTER FilterPattern
OpenEdge.BusinessLogic.Filter.FilterParser Parser
OpenEdge.Core.Util.BuilderRegistry Registry


Method Detail
Top

PROTECTED LOGICAL AppendArrayCharacterValue (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Appends a character value to an array (convenience)
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC OpenEdge.BusinessLogic.Filter.FilterParserBuilder Build (character)

/* Returns a parser builder for a give filter pattern.
Parameters:
pPattern CHARACTER
Returns OpenEdge.BusinessLogic.Filter.FilterParserBuilder
FilterParserBuilder A builder for a parser for that pattern.
Top

PUBLIC OpenEdge.BusinessLogic.Filter.FilterParserBuilder Build (JsonArray)

/* Builds a parser for a JSON filter. This array version loops through the
array and passes any OBJECT or STRING entries to the relevant Build()
method.
Parameters:
pFilter Progress.Json.ObjectModel.JsonArray
Returns OpenEdge.BusinessLogic.Filter.FilterParserBuilder
FilterParserBuilder The filter parser builder to use
Top

PUBLIC OpenEdge.BusinessLogic.Filter.FilterParserBuilder Build (JsonObject)

/* Builds a parser for a JSON filter
Specialised JSON filter parsers are used. To figure out which on to
use
1. Look for a string property called mappingType and use that property value
2. Loop for a property in the JSON that matches one of the
registered filter parsers.
3. Return without raising error.
Parameters:
pFilter Progress.Json.ObjectModel.JsonObject
Returns OpenEdge.BusinessLogic.Filter.FilterParserBuilder
FilterParserBuilder The filter parser builder to use
Top

PROTECTED OpenEdge.BusinessLogic.Filter.FilterParser BuildParser ()

/* Builds a parser for a JSON filter
Returns OpenEdge.BusinessLogic.Filter.FilterParser
FilterParser A usable parser, if one exists. May return NULL
Top

PROTECTED ClearOptions ()

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Clears all options for this builder
Top

PROTECTED LOGICAL FindConfigRecord (buffer, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Internal helper method to perform the find. This method attempts to find a record using
the input buffer.
Parameters:
pConfig buffer
pName CHARACTER
Returns LOGICAL
logical True if a config record was found.
Top

PROTECTED DATETIME-TZ GetOptionDateTimeValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's datetime value
Parameters:
pcName CHARACTER
Returns DATETIME-TZ
datetime-tz the value
Top

PROTECTED LOGICAL GetOptionLogicalValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's logical value
Parameters:
pcName CHARACTER
Returns LOGICAL
logical the value
Top

PROTECTED LONGCHAR GetOptionLongcharValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's longchar value
Parameters:
pcName CHARACTER
Returns LONGCHAR
longchar the value
Top

PROTECTED DECIMAL GetOptionNumericValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's decimal value
Parameters:
pcName CHARACTER
Returns DECIMAL
decimal the value
Top

PROTECTED Object GetOptionObjectValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's object value
Parameters:
pcName CHARACTER
Returns Object
Object the value
Top

PROTECTED CHARACTER GetOptionStringArrayValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character array value
Parameters:
pcName CHARACTER
Returns CHARACTER
character[] the value
Top

PROTECTED CHARACTER GetOptionStringValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character value
Parameters:
pcName CHARACTER
Returns CHARACTER
character the value
Top

PROTECTED LOGICAL HasOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Checks whether a config option already exists
Parameters:
pcConfigName CHARACTER
Returns LOGICAL
logical True if the named configuration option exists
Top

PROTECTED LOGICAL RemoveOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Removes an option
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

PROTECTED LOGICAL SetOption (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, character[])

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, datetime-tz)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a datetime-tzvalue as an option
Parameters:
pcName CHARACTER
ptValue DATETIME-TZ
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, decimal)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an numeric value as an option
Parameters:
pcName CHARACTER
pdValue DECIMAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, logical)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a logical value as an option
Parameters:
pcName CHARACTER
plValue LOGICAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pcName CHARACTER
poValue Object
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (Class, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pName Progress.Lang.Class
pValue Object
Returns LOGICAL
logical True is the option was overwritten
Top

PUBLIC OpenEdge.BusinessLogic.Filter.FilterParserBuilder TableName (character)

/* Sets the table for which this filter applies, if any
Parameters:
pTable CHARACTER
Returns OpenEdge.BusinessLogic.Filter.FilterParserBuilder
FilterParserBuilder this object
Top

PUBLIC OpenEdge.BusinessLogic.Filter.FilterParserBuilder TableName (character[])

/* Sets the table for which this filter applies, if any
Parameters:
pTable CHARACTER
Returns OpenEdge.BusinessLogic.Filter.FilterParserBuilder
FilterParserBuilder this object


Constructor Detail
Top

PUBLIC FilterParserBuilder (character)

/* Constructor
Parameters:
pPattern CHARACTER


Property Detail
Top

PUBLIC CHARACTER FilterPattern

Returns CHARACTER
Top

PUBLIC OpenEdge.BusinessLogic.Filter.FilterParser Parser

Returns OpenEdge.BusinessLogic.Filter.FilterParser
Top

PUBLIC OpenEdge.Core.Util.BuilderRegistry Registry

Returns OpenEdge.Core.Util.BuilderRegistry


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0