Namespace: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb
Class 
ProparseWebNode Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Inherits: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Implements: Consultingwerk.Studio.ProparseApi.INode
Inherited by: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebBlockNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebProgramRootNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldRefNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebProparseDirectiveNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebRecordNameNode

File:ProparseWebNode
Purpose:Represents a JPNode
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Wed Oct 21 09:04:43 CEST 2020
Purpose: Constructor for the ProparseWebNode class
Notes:

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



Top Method Summary
Options Name Purpose
+ Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode Array (IProparseWebSession, JsonArray) Turns a JsonArray into an array of ProparseWebNode
# CHARACTER Array (JsonArray) Turns a JsonArray of characters into an array of characters
# LOGICAL CanGetProperty (JsonObject, character) Helper method to check whether a property can be retrieved from a JSON object
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes (NodeTypesEnum) Returns the set of child nodes
+ LOGICAL Equals (Object) Overrides Equals method to compare NodeNums
+ Consultingwerk.Studio.ProparseApi.INode FirstDirectChild (NodeTypesEnum) Find the first direct child with a given node type.
# Consultingwerk.Studio.ProparseApi.INode GetNode (character) Helper method to get a node from the backend and create the object
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# InitArrays () Initializes the extent properties
+ InsertTextAfter (longchar) Parses and inserts text after the node
# Progress.Lang.Object PostRequest (character, JsonConstruct) Executes a POST request on the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.INode Query (NodeTypesEnum) Returns an Array of all node types of the given node type
# Progress.Json.ObjectModel.JsonArray RequestJsonArray (character) Helper method to get a JSON array from the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Progress.Json.ObjectModel.JsonObject RequestJsonObject (character) Helper method to get a JSON object from the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ CHARACTER ToString () Returns a String representation of the node
+ CHARACTER ToStringFulltext () Get the full, preprocessed text from a node
+ CHARACTER ToStringSourcetext () Get the full, not preprocessed text from a node

Top Constructor Summary
Options Name Purpose
+ ProparseWebNode (IProparseWebSession, JsonObject) Constructor for the ProparseWebNode class

Top Property Summary
Options Name Purpose
+ CHARACTER AllLeadingHiddenText
# Progress.Json.ObjectModel.JsonObject BaseJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.ICall Call
+ Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes
+ INTEGER Column
+ CHARACTER Comments
# Progress.Json.ObjectModel.JsonObject DetailsJson
# Progress.Json.ObjectModel.JsonObject DetailsLinksJson
+ Consultingwerk.Studio.ProparseApi.IFieldContainer FieldContainer
+ CHARACTER FileName
+ CHARACTER FileNames
+ Consultingwerk.Studio.ProparseApi.INode FirstChild
+ Consultingwerk.Studio.ProparseApi.INode FirstNaturalChild
+ Consultingwerk.Studio.ProparseApi.INode LastChild
+ Consultingwerk.Studio.ProparseApi.INode LastDescendant
+ INTEGER Line
# Progress.Json.ObjectModel.JsonObject Links
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ LOGICAL Natural
+ Consultingwerk.Studio.ProparseApi.INode NextNode
+ Consultingwerk.Studio.ProparseApi.INode NextSibling
+ INTEGER NodeNum
+ Consultingwerk.Studio.ProparseApi.INode Parent
+ Consultingwerk.Studio.ProparseApi.INode PrevNode
+ Consultingwerk.Studio.ProparseApi.INode PrevSibling
# Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ LOGICAL StateHead
+ Consultingwerk.Studio.ProparseApi.INode Statement
+ Consultingwerk.Studio.ProparseApi.NodeSubTypesEnum SubType
+ Consultingwerk.Studio.ProparseApi.ISymbol Symbol
+ CHARACTER Text
+ Consultingwerk.Studio.ProparseApi.NodeTypesEnum Type


Method Detail
Top

PUBLIC Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode Array (IProparseWebSession, JsonArray)
Purpose: Turns a JsonArray into an array of ProparseWebNode
Notes:

Parameters:
poSession Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
The session for which this array is created
poJsonArray Progress.Json.ObjectModel.JsonArray
The source JsonArray
Returns Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
The resulting ProparseWebNode array
Top

PROTECTED CHARACTER Array (JsonArray)
Purpose: Turns a JsonArray of characters into an array of characters
Notes:

Parameters:
poJsonArray Progress.Json.ObjectModel.JsonArray
JsonArray containing characters
Returns CHARACTER
Araay with the characters from poJsonArrays
Top

PROTECTED LOGICAL CanGetProperty (JsonObject, character)
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to check whether a property can be retrieved from a JSON object
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The Json object to retrieve the property from
pcProperty CHARACTER
Name of the property to retrieve
Returns LOGICAL
TRUE/FALSE whether pcProperty can be retrieved from poJson
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes (NodeTypesEnum)
Purpose: Returns the set of child nodes
Notes:

Parameters:
poNodeType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The Node Type to find
Returns Consultingwerk.Studio.ProparseApi.NodesSet
The set of child nodes of the given type
Top

PUBLIC LOGICAL Equals (Object)
Purpose: Overrides Equals method to compare NodeNums
Notes:

Parameters:
poNode Progress.Lang.Object
Object to compare with THIS-OBJECT
Returns LOGICAL
True if the given object has the same NodeNum, else false
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode FirstDirectChild (NodeTypesEnum)
Purpose: Find the first direct child with a given node type.
Notes:

Parameters:
poNodeType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The Node Type to find
Returns Consultingwerk.Studio.ProparseApi.INode
The INode instance
Top

PROTECTED Consultingwerk.Studio.ProparseApi.INode GetNode (character)
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a node from the backend and create the object
Notes:

Parameters:
pcLink CHARACTER
Link to the node resource
Returns Consultingwerk.Studio.ProparseApi.INode
The requested node
Top

PROTECTED InitArrays ()
Purpose: Initializes the extent properties
Notes:

Top

PUBLIC InsertTextAfter (longchar)
Purpose: Parses and inserts text after the node
Notes: The resulting nodes are added as siblings

Parameters:
plcText LONGCHAR
The text to insert
Top

PROTECTED Progress.Lang.Object PostRequest (character, JsonConstruct)
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Executes a POST request on the server
Notes:

Parameters:
pcUri CHARACTER
URI for the request
poJson Progress.Json.ObjectModel.JsonConstruct
Content for the request
Returns Progress.Lang.Object
The response entity
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode Query (NodeTypesEnum)
Purpose: Returns an Array of all node types of the given node type
Notes:

Parameters:
poNodeType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The NodeTypeEnum representing the node type
Returns Consultingwerk.Studio.ProparseApi.INode
The array of INode instances
Top

PROTECTED Progress.Json.ObjectModel.JsonArray RequestJsonArray (character)
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a JSON array from the server
Notes:

Parameters:
pcRequestLink CHARACTER
Link to the requested resource
Returns Progress.Json.ObjectModel.JsonArray
JSON array from the response
Top

PROTECTED Progress.Json.ObjectModel.JsonObject RequestJsonObject (character)
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a JSON object from the server
Notes:

Parameters:
pcRequestLink CHARACTER
Link to the requested resource
Returns Progress.Json.ObjectModel.JsonObject
JSON object from the response
Top

PUBLIC CHARACTER ToString ()
Purpose: Returns a String representation of the node
Notes:

Returns CHARACTER
String representation of the node
Top

PUBLIC CHARACTER ToStringFulltext ()
Purpose: Get the full, preprocessed text from a node
Notes:

Returns CHARACTER
The full, preprocessed text from a node
Top

PUBLIC CHARACTER ToStringSourcetext ()
Purpose: Get the full, not preprocessed text from a node
Notes:

Returns CHARACTER
The full, not preprocessed text from a node


Constructor Detail
Top

PUBLIC ProparseWebNode (IProparseWebSession, JsonObject)
Purpose: Constructor for the ProparseWebNode class
Notes:

Parameters:
poSession Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
The session for which this object is being created, also holds HttpClient and JSessionID
poJson Progress.Json.ObjectModel.JsonObject
The JsonObject from which this object is being created


Property Detail
Top

PUBLIC CHARACTER AllLeadingHiddenText

Returns CHARACTER
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BaseJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ICall Call

Returns Consultingwerk.Studio.ProparseApi.ICall
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes

Returns Consultingwerk.Studio.ProparseApi.NodesSet
Top

PUBLIC INTEGER Column

Returns INTEGER
Top

PUBLIC CHARACTER Comments

Returns CHARACTER
Top

PROTECTED Progress.Json.ObjectModel.JsonObject DetailsJson

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject DetailsLinksJson

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IFieldContainer FieldContainer

Returns Consultingwerk.Studio.ProparseApi.IFieldContainer
Top

PUBLIC CHARACTER FileName

Returns CHARACTER
Top

PUBLIC CHARACTER FileNames

Returns CHARACTER
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode FirstChild

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode FirstNaturalChild

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode LastChild

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode LastDescendant

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC INTEGER Line

Returns INTEGER
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Links
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC LOGICAL Natural

Returns LOGICAL
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode NextNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode NextSibling

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC INTEGER NodeNum

Returns INTEGER
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode Parent

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode PrevNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode PrevSibling

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PROTECTED Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
Top

PUBLIC LOGICAL StateHead

Returns LOGICAL
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode Statement

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodeSubTypesEnum SubType

Returns Consultingwerk.Studio.ProparseApi.NodeSubTypesEnum
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbol Symbol

Returns Consultingwerk.Studio.ProparseApi.ISymbol
Top

PUBLIC CHARACTER Text

Returns CHARACTER
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodeTypesEnum Type

Returns Consultingwerk.Studio.ProparseApi.NodeTypesEnum


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:16:04