Namespace: OpenEdge.Web.DataObject.Writer
Class
MappingFileServiceWriter
Parent classes:
Inherits: OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter

/* *************************************************************************************************************************
Copyright (c) 2018 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:MappingFileServiceWriter
Purpose:Serializes a DataObjectService to a Data Object Handler mapping file JSON format
Author(s):pjudge
Created:2018-08-06
/* Default constructor




Method Summary
Options Name Purpose
Clear () /** Clears or empties the target */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Close () /** Closes the writer. */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Flush () /** Flushes(writes) the input to the target */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonObject GetCatalogSchema (SemanticVersion) /* Returns a schema for a Data Object Service Catalog @param SemanticVersion The catalog version @return JsonObject The catalog JSON-schema */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonObject GetOperationJson (JsonObject, character, MethodEnum)
Progress.Json.ObjectModel.JsonObject GetSchemaJson (JsonObject, character)
Progress.Json.ObjectModel.JsonObject GetServiceJson (DataObjectService)
Open ()
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:Open ()
Write (Object) /* Writes an object array into the Value. @param Progress.Lang.Object An object to write. It will typically be in the OpenEdge.Web.DataObject package and be part of a DataObjectService */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Write (Object[]) /* Writes an object array into the Value. @param Progress.Lang.Object[] A set of objects to write. They will typically be in the OpenEdge.Web.DataObject package and be part of a DataObjectService */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonArray WriteArgumentWriters (BuilderRegistry) /* Writes the Operation Cookies into JSON @param OperationOptions A set of options @return JsonArray */
WriteDOS (DataObjectService) /* Writes a single Data Object Service @param DataObjectService The service to write */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
WriteEntityOperation (MappedOperation, JsonObject) /* Writes the contents of anh ENTITY operation to the JSON @param MappedOperation The operation to write @param JsonObject The JSON output */
WriteFileOperation (MappedOperation, JsonObject) /* Writes the contents of a FILE operation to the JSON @param MappedOperation The operation to write @param JsonObject The JSON output */
Progress.Json.ObjectModel.JsonConstruct WriteMessageElement (OperationParameter) /* Builds the appropriate JSON for a parameter's messgae element(s) @param OperationParameter @return JsonConstruct Either unknown, or a JsonObject or JsonArray */
WriteOperation (DataObjectService, MappedOperation) /* Writes a single MappedOperation @param DataObjectService The current service @param MappedOperation The service operation to write */
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteOperation (DataObjectService, MappedOperation)
Progress.Json.ObjectModel.JsonArray WriteOperationCookies (CookieCollection) /* Writes the Operation Cookies into JSON @param OperationOptions A set of options @return JsonArray */
Progress.Json.ObjectModel.JsonObject WriteOperationHeaders (HttpHeaderCollection) /* Writes the Operation Headers into JSON @param OperationOptions A set of options @return JsonObject The JSON data */
Progress.Json.ObjectModel.JsonObject WriteOperationOptions (OperationOptions) /* Writes the Operation options into JSON @param OperationOptions A set of options @return JsonObject */
WriteSchema (DataObjectService, handle) /* Writes a single schema @param DataObjectService The current service @param handle The service schema to write */
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteSchema (DataObjectService, handle)
Progress.Json.ObjectModel.JsonObject WriteSchemaTable (handle) /* Writes schema data for a table @param handle The schema to write */
WriteService (DataObjectService) /* Writes a single Data Object Service @param DataObjectService The service to write */
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteService (DataObjectService)
WriteTuple (Object, Object) /* Writes a tuple (key-value pair). This is effectively a VIRTUAL method (no default behaviour but not compiled enforcement either). @param Progress.Lang.Object The key value - property name (required) @param Progress.Lang.Object A value to be written for the property. May be null. */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
WriteUnknownOperation (MappedOperation, JsonObject) /* Writes the contents of an unknown (undefined) operation to the JSON @param MappedOperation The operation to write @param JsonObject The JSON output */
WriteURI (URI) /* Writes a URI to the output. This is effectively a VIRTUAL method (no default behaviour but not compiled enforcement either). @param URI The URI to write */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonObject WriteVoidOperation (MappedOperation, JsonObject) /* Writes the contents of a VOID operation to the JSON @param MappedOperation The operation to write @param JsonObject The JSON output */

Constructor Summary
Options Name Purpose
MappingFileServiceWriter () /* Default constructor */

Property Summary
Options Name Purpose
ILogWriter Logger
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Lang.Object Value
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Lang.Class ValueType
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter


Method Detail
Top

PUBLIC Clear ()

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Purpose: Clears or empties the target
Top

PUBLIC Close ()

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Purpose: Closes the writer.
Top

PUBLIC Flush ()

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Purpose: Flushes(writes) the input to the target
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetCatalogSchema (SemanticVersion)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Returns a schema for a Data Object Service Catalog
Parameters:
pVersion SemanticVersion
Returns Progress.Json.ObjectModel.JsonObject
JsonObject The catalog JSON-schema
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetOperationJson (JsonObject, character, MethodEnum)

Parameters:
pServiceData Progress.Json.ObjectModel.JsonObject
pUri CHARACTER
pMethod OpenEdge.Net.HTTP.MethodEnum
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetSchemaJson (JsonObject, character)

Parameters:
pServiceData Progress.Json.ObjectModel.JsonObject
pSchemaName CHARACTER
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetServiceJson (DataObjectService)

Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC Open ()

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:Open ()
Top

PUBLIC Write (Object)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes an object array into the Value.
be in the OpenEdge.Web.DataObject package and be part of
a DataObjectService
Parameters:
pData Progress.Lang.Object
Top

PUBLIC Write (Object[])

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes an object array into the Value.
be in the OpenEdge.Web.DataObject package and be part of
a DataObjectService
Parameters:
pData Progress.Lang.Object
Top

PROTECTED Progress.Json.ObjectModel.JsonArray WriteArgumentWriters (BuilderRegistry)

/* Writes the Operation Cookies into JSON
Parameters:
pData OpenEdge.Core.Util.BuilderRegistry
Returns Progress.Json.ObjectModel.JsonArray
JsonArray
Top

PROTECTED WriteDOS (DataObjectService)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes a single Data Object Service
Parameters:
pData OpenEdge.Web.DataObject.DataObjectService
Top

PROTECTED WriteEntityOperation (MappedOperation, JsonObject)

/* Writes the contents of anh ENTITY operation to the JSON
Parameters:
pOperation OpenEdge.Web.DataObject.MappedOperation
pJson Progress.Json.ObjectModel.JsonObject
Top

PROTECTED WriteFileOperation (MappedOperation, JsonObject)

/* Writes the contents of a FILE operation to the JSON
Parameters:
pOperation OpenEdge.Web.DataObject.MappedOperation
pJson Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonConstruct WriteMessageElement (OperationParameter)

/* Builds the appropriate JSON for a parameter's messgae element(s)
Parameters:
pParam OpenEdge.Web.DataObject.OperationParameter
Returns Progress.Json.ObjectModel.JsonConstruct
JsonConstruct Either unknown, or a JsonObject or JsonArray
Top

PROTECTED WriteOperation (DataObjectService, MappedOperation)

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteOperation (DataObjectService, MappedOperation)
/* Writes a single MappedOperation
Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
pOperation OpenEdge.Web.DataObject.MappedOperation
Top

PROTECTED Progress.Json.ObjectModel.JsonArray WriteOperationCookies (CookieCollection)

/* Writes the Operation Cookies into JSON
Parameters:
pData OpenEdge.Net.HTTP.CookieCollection
Returns Progress.Json.ObjectModel.JsonArray
JsonArray
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteOperationHeaders (HttpHeaderCollection)

/* Writes the Operation Headers into JSON
Parameters:
pData OpenEdge.Net.HTTP.HttpHeaderCollection
Returns Progress.Json.ObjectModel.JsonObject
JsonObject The JSON data
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteOperationOptions (OperationOptions)

/* Writes the Operation options into JSON
Parameters:
pData OpenEdge.Web.DataObject.OperationOptions
Returns Progress.Json.ObjectModel.JsonObject
JsonObject
Top

PROTECTED WriteSchema (DataObjectService, handle)

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteSchema (DataObjectService, handle)
/* Writes a single schema
Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
pSchema HANDLE
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteSchemaTable (handle)

/* Writes schema data for a table
Parameters:
pSchema HANDLE
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED WriteService (DataObjectService)

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteService (DataObjectService)
/* Writes a single Data Object Service
Parameters:
pData OpenEdge.Web.DataObject.DataObjectService
Top

PROTECTED WriteTuple (Object, Object)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes a tuple (key-value pair).
This is effectively a VIRTUAL method (no default behaviour but not compiled enforcement either).
Parameters:
pKey Progress.Lang.Object
pValue Progress.Lang.Object
Top

PROTECTED WriteUnknownOperation (MappedOperation, JsonObject)

/* Writes the contents of an unknown (undefined) operation to the JSON
Parameters:
pOperation OpenEdge.Web.DataObject.MappedOperation
pJson Progress.Json.ObjectModel.JsonObject
Top

PROTECTED WriteURI (URI)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes a URI to the output. This is effectively a VIRTUAL method (no default behaviour
but not compiled enforcement either).
Parameters:
pData URI
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteVoidOperation (MappedOperation, JsonObject)

/* Writes the contents of a VOID operation to the JSON
Parameters:
pOperation OpenEdge.Web.DataObject.MappedOperation
pJson Progress.Json.ObjectModel.JsonObject
Returns Progress.Json.ObjectModel.JsonObject


Constructor Detail
Top

PUBLIC MappingFileServiceWriter ()

/* Default constructor


Property Detail
Top

PUBLIC ILogWriter Logger

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Returns ILogWriter
Top

PUBLIC Progress.Lang.Object Value

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Class ValueType

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Returns Progress.Lang.Class


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0