Namespace: Consultingwerk.Framework
Class 
ConfigurationFileParser Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.ConfigurationFileParser

Inherits: Progress.Lang.Object

File:ConfigurationFileParser
Purpose:Parses a JSON Configuration File and processes the
configuration file inheritance
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Jun 23 17:30:05 CEST 2017
Notes:https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094594/JSON+Configuration+File+Format

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# InheritJsonArray (JsonObject, JsonObject, JsonObject, character) Merges two JsonArrays into the merged JsonArray
# InheritJsonObject (JsonObject, JsonObject, JsonObject, character) Merges two JsonObject into the merged JsonObject
# Progress.Json.ObjectModel.JsonObject MergeConfiguration (JsonObject, JsonObject) Merges two JsonObjects with configuration data
# MergeEnvironment (JsonObject, JsonObject) Merges the Environment property
+ Progress.Json.ObjectModel.JsonObject ParseConfigurationFile (character) Parses the given configuration file
# Progress.Json.ObjectModel.JsonObject PerformParsing (character)
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns the JsonObject representing the most recently parsed file

Top Constructor Summary
Options Name Purpose
+ ConfigurationFileParser () Constructor for the ConfigurationFileParser class
+ ConfigurationFileParser (character) Constructor for the ConfigurationFileParser class


Method Detail
Top

PROTECTED InheritJsonArray (JsonObject, JsonObject, JsonObject, character)
Purpose: Merges two JsonArrays into the merged JsonArray
Notes:

Parameters:
poMerged Progress.Json.ObjectModel.JsonObject
The merged JsonObject
poBasedOn Progress.Json.ObjectModel.JsonObject
The base JsonObject
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the overlaying configuration
pcProperty CHARACTER
The name of the property
Top

PROTECTED InheritJsonObject (JsonObject, JsonObject, JsonObject, character)
Purpose: Merges two JsonObject into the merged JsonObject
Notes:

Parameters:
poMerged Progress.Json.ObjectModel.JsonObject
The merged JsonObject
poBasedOn Progress.Json.ObjectModel.JsonObject
The base JsonObject
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the overlaying configuration
pcProperty CHARACTER
The name of the property
Top

PROTECTED Progress.Json.ObjectModel.JsonObject MergeConfiguration (JsonObject, JsonObject)
Purpose: Merges two JsonObjects with configuration data
Notes:

Parameters:
poBasedOn Progress.Json.ObjectModel.JsonObject
The base JsonObject
poConfiguration Progress.Json.ObjectModel.JsonObject
The JsonObject with the overlaying configuration
Returns Progress.Json.ObjectModel.JsonObject
The merged configuration JsonObject
Top

PROTECTED MergeEnvironment (JsonObject, JsonObject)
Purpose: Merges the Environment property
Notes:

Parameters:
poMerged Progress.Json.ObjectModel.JsonObject
The merged JsonObject
poBasedOn Progress.Json.ObjectModel.JsonObject
The base JsonObject
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ParseConfigurationFile (character)
Purpose: Parses the given configuration file
Notes:

Parameters:
pcFileName CHARACTER
The name of the configuration file to parse
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the most recently parsed file
Top

PROTECTED Progress.Json.ObjectModel.JsonObject PerformParsing (character)
Purpose:
Notes:

Parameters:
pcFileName CHARACTER
The name of the configuration file to parse
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the most recently parsed file
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()
Purpose: Returns the JsonObject representing the most recently parsed file
Notes: Throws an error, when no configuration file has been parsed yet

Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the most recently parsed file


Constructor Detail
Top

PUBLIC ConfigurationFileParser ()
Purpose: Constructor for the ConfigurationFileParser class
Notes:

Top

PUBLIC ConfigurationFileParser (character)
Purpose: Constructor for the ConfigurationFileParser class
Notes:

Parameters:
pcFileName CHARACTER
The name of the configuration file to parse


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:51:24