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
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 */
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

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

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

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

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

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

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

FilterParserBuilder (character)

/* Constructor
Parameters:
pPattern CHARACTER


Property Detail
Top

CHARACTER FilterPattern

Returns CHARACTER
Top

OpenEdge.BusinessLogic.Filter.FilterParser Parser

Returns OpenEdge.BusinessLogic.Filter.FilterParser
Top

OpenEdge.Core.Util.BuilderRegistry Registry

Returns OpenEdge.Core.Util.BuilderRegistry


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15