Namespace: Consultingwerk
Class 
BufferFieldName Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.JsonSerializable
Implements: Consultingwerk.IJsonSerializable, Consultingwerk.IQueryExpression
SERIALIZABLE

File:BufferFieldName
Purpose:A structure that can hold all possible components
of a buffer field reference database.table.field[index]
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Sep 10 14:09:47 CEST 2012
Notes:This class does not perform any validation of the property
values
Purpose: Gets and sets the Database Name component
Notes:



Top Method Summary
Options Name Purpose
# CHARACTER AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
# CHARACTER AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ Progress.Lang.Object Clone () Clones the object instance
+ Deserialize (longchar) Deserializes a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ DeserializeFromJsonObject (JsonObject) Initializes the object instance based on the passed in JsonObject representation of the object instance
Inherited from Consultingwerk.JsonSerializable
# DeserializeProperty (JsonObject, character, character) Deserializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL Equals (character) Returns true when the passed in field name matches the BufferFieldName instance
# IEnumerable GetEnumerableInstance (character) Returns an instance of the enumerable type
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER GetExpression () Returns the Expression to be used in a Query String
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR Serialize () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
# SerializeProperty (JsonObject, character, character) Serializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER ToString () Returns a string that represents the current object.
+ CHARACTER WithTableName () Returns the field name including the table name when present
+ LONGCHAR WriteJson () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR WriteXml () Returns an XML LONGCHAR representation of the object instance
Inherited from Consultingwerk.JsonSerializable
+ HANDLE XmlSerialize (handle) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.JsonSerializable
+ XmlSerializeProperties (handle) Serializes the properties of this object instance as child nodes of the given node
Inherited from Consultingwerk.JsonSerializable
# XmlSerializeProperty (handle, character, character) Serializes a single property value to the current parent XmlNode
Inherited from Consultingwerk.JsonSerializable

Top Constructor Summary
Options Name Purpose
+ BufferFieldName () Constructor for the BufferFieldName class
+ BufferFieldName (character) Constructor for the BufferFieldName class
+ BufferFieldName (character, character) Constructor for the BufferFieldName class
+ BufferFieldName (character, character, character) Constructor for the BufferFieldName class
+ BufferFieldName (character, character, character, integer) Constructor for the BufferFieldName class
+ BufferFieldName (character, character, integer) Constructor for the BufferFieldName class
+ BufferFieldName (handle) Constructor for the BufferFieldName class
+ BufferFieldName (handle, character) Constructor for the BufferFieldName class

Top Property Summary
Options Name Purpose
+ CHARACTER DatabaseName
+ CHARACTER FieldName
+ INTEGER Index
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER TableName
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED CHARACTER AddSerializableProperties ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Returns CHARACTER
The value of the SerializableProperties property
Top

PROTECTED AddSerializableProperties (character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Add a list of Serializable Properties to the SerializableProperties property
Notes: Required as a workaround to full reflection only. We *may* remove this
method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties CHARACTER
A comma delimited list of serializable properties
Top

PROTECTED CHARACTER AddSerializableProperties (Class)

Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the given class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Parameters:
poClass Progress.Lang.Class
The declaring class
Returns CHARACTER
The value of the SerializableProperties property
Top

PUBLIC Progress.Lang.Object Clone ()

Purpose: Clones the object instance
Notes:

Returns Progress.Lang.Object
The cloned object instance
Top

PUBLIC Deserialize (longchar)

Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedReprasentation LONGCHAR
The stored LONGCHAR representation of the objects data
Top

PUBLIC DeserializeFromJsonObject (JsonObject)

Inherited from Consultingwerk.JsonSerializable
Purpose: Initializes the object instance based on the passed in JsonObject
representation of the object instance
Notes:

Parameters:
poJsonObject JsonObject
The stored JsonObject representation of the objects data
Top

PROTECTED DeserializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization
Notes:

Parameters:
poJsonObject JsonObject
The reference to the source JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC LOGICAL Equals (character)

Purpose: Returns true when the passed in field name matches the BufferFieldName instance
Notes: Compares Database and Table name when populated in both instances

Parameters:
pcFieldName CHARACTER
The field name to ocmpare
Returns LOGICAL
Logical value indicating if the passed in fieldname matches the BufferFieldName instance
Top

PROTECTED IEnumerable GetEnumerableInstance (character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an instance of the enumerable type
Notes: When the property value is referencing a valie list instance, this
instance is returned. If not, we attempt to create a new instance

Parameters:
pcProperty CHARACTER
The name of the List property
Returns IEnumerable
The instance of the enumerable type
Top

PUBLIC CHARACTER GetExpression ()

Purpose: Returns the Expression to be used in a Query String
Notes:

Returns CHARACTER
The CHARACTER Expression
Top

PUBLIC CHARACTER GetSerializableProperties ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns the meta data of the serializable properties
Notes:

Returns CHARACTER
The serializable properties meta data as a comma delimited list
Top

PUBLIC LONGCHAR Serialize ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PROTECTED SerializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization

Parameters:
poJsonObject JsonObject
The reference to the target JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a JsonObject representation of the state of the class instance
Notes: Returns the classname together with the Json serialization of the
object

Returns Progress.Json.ObjectModel.JsonObject
The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data
Top

PUBLIC CHARACTER ToString ()

Purpose: Returns a string that represents the current object.
Notes:

Returns CHARACTER
A string that represents the current object.
Top

PUBLIC CHARACTER WithTableName ()

Purpose: Returns the field name including the table name when present
Notes:

Returns CHARACTER
The field name including the table naem
Top

PUBLIC LONGCHAR WriteJson ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization
This method is a facade to the JsonSerializable:Serialize method

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC LONGCHAR WriteXml ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an XML LONGCHAR representation of the object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC HANDLE XmlSerialize (handle)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of the current object instance to
an existing X-NODEREF object
Notes:

Parameters:
phParent HANDLE
The reference to the parent XML Node or Document
Returns HANDLE
The X-NODEREF with the properties of the serialized object
Top

PUBLIC XmlSerializeProperties (handle)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of this object instance as child nodes of
the given node
Notes:

Parameters:
phObjectNode HANDLE
The reference to the X-NODEREF object that represents the node for the current instance
Top

PROTECTED XmlSerializeProperty (handle, character, character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current parent XmlNode
Notes: Allows to override the handling of individual properties during the
XmlSerialization

Parameters:
phParentNode HANDLE
The reference to the parent XML Node
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property


Constructor Detail
Top

PUBLIC BufferFieldName ()

Purpose: Constructor for the BufferFieldName class
Notes:

Top

PUBLIC BufferFieldName (character)

Purpose: Constructor for the BufferFieldName class
Notes: Supports db.table.field, table.field, field with and without index (extent)

Parameters:
pcFieldName CHARACTER
The field name
Top

PUBLIC BufferFieldName (character, character)

Purpose: Constructor for the BufferFieldName class
Notes:

Parameters:
pcTableName CHARACTER
The table name
pcFieldName CHARACTER
The field name
Top

PUBLIC BufferFieldName (character, character, character)

Purpose: Constructor for the BufferFieldName class
Notes:

Parameters:
pcDatabaseName CHARACTER
The database name
pcTableName CHARACTER
The table name
pcFieldName CHARACTER
The field name
Top

PUBLIC BufferFieldName (character, character, character, integer)

Purpose: Constructor for the BufferFieldName class
Notes:

Parameters:
pcDatabaseName CHARACTER
The database name
pcTableName CHARACTER
The table name
pcFieldName CHARACTER
The field name
piIndex INTEGER
The field index (extent)
Top

PUBLIC BufferFieldName (character, character, integer)

Purpose: Constructor for the BufferFieldName class
Notes:

Parameters:
pcTableName CHARACTER
The table name
pcFieldName CHARACTER
The field name
piIndex INTEGER
The field index (extent)
Top

PUBLIC BufferFieldName (handle)

Purpose: Constructor for the BufferFieldName class
Notes:

Parameters:
phBufferField HANDLE
The Buffer Field to use to populate the buffer field name
Top

PUBLIC BufferFieldName (handle, character)

Purpose: Constructor for the BufferFieldName class
Notes:

Parameters:
phBuffer HANDLE
The handle of the Buffer that contains the field
pcFieldName CHARACTER
The name of the Buffer field


Property Detail
Top

PUBLIC CHARACTER DatabaseName


Returns CHARACTER
Top

PUBLIC CHARACTER FieldName


Returns CHARACTER
Top

PUBLIC INTEGER Index


Returns INTEGER
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter

Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC LOGICAL SerializeEmptyLists

Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL SerializeNullValues

Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC CHARACTER TableName


Returns CHARACTER
Top

PUBLIC LOGICAL UseSerializedTypeInformation

Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       21.11.2022 08:21:39