Namespace: OpenEdge.DataAdmin.Core
Type: Class CodeWriter
Parent Classes:
Inherits: OpenEdge.DataAdmin.Core.DataAdminWriter
Implements: IDataAdminExporter


/* Copyright (c) 2011-2016 by progress Software Corporation.
/*
/* all rights reserved. no part of this program or document
/* may be reproduced in any form or by any means without
/* permission in writing from progress Software Corporation.
File:CodeWriter
Author(s):hdaniels
Created:Mon Aug 16 20:18:09 EDT 2010



Method Summary
  Options Name Purpose
  OpenEdge.DataAdmin.Binding.IContextTree CreateContextTree ()
  CHARACTER GetArea (character)
  CHARACTER GetAreaExpression (handle)
  CHARACTER GetAuthenticationSystem (character)
  HANDLE GetChildBuffer (handle, character) /* we could have just used the dataset as of current, but this is more correct since we want the buffer if it is a child */
  HANDLE GetChildQuery (handle, character)
  HANDLE GetChildRelation (handle, character)
  CHARACTER GetCollectionClass (character)
  CHARACTER GetCollectionInstance (character)
  CHARACTER GetCollectionName (character)
  CHARACTER GetComment (handle, character, character) /* Sun Oct 17 15:10:33 EDT 2010 */
  CHARACTER GetDate ()
  CHARACTER GetEntityClass (character)
  CHARACTER GetEntityInstance (character)
  CHARACTER GetEntityInterface (character)
  CHARACTER GetNameExpression (handle)
  CHARACTER GetNote (handle)
  HANDLE GetPartitionChangeQuery (handle, log) /* creates a query with changed partitions @param partition buffer @param true if search from grandparent (only valid when parent ttPartitionPolicyDetail ) to precheck all details */
  CHARACTER GetPolicyAreaExpression ()
  CHARACTER GetStateDefault (handle)
  CHARACTER GetTable (character)
  CHARACTER GetTenantGroup (character)
  LOGICAL HasPolicyPartitionChanges (handle)
  OpenEdge.DataAdmin.Binding.IContextTree Write (IDataAdminSerializable, character)
  writeAddToParent (handle)
  WriteBuffer (handle)
  WriteCdcChangeTable (handle)
  WriteCdcField (handle, handle)
  WriteCdcFieldPolicies (handle)
  WriteCdcIdentifyingField (handle)
  WriteCdcLevel (handle)
  WriteCdcState (handle)
  WriteCdcTable (character, character, character) /* The CDC implementation requires owner name as well since the CDC ABL API supports PUB and non-PUB tables */
  WriteCode (handle)
  WriteCreateInService (handle)
  WriteDefs (handle)
  WriteErrorHandler ()
  WriteField (handle)
  WriteHeader (handle)
  WriteInit ()
  WriteLocalIndexBuffer (handle, handle)
  WritePartitionBuffer (handle, handle)
  WritePartitionPolicyDetails (handle) /* end method. */
  WritePartitionPolicyFieldBuffer (handle, handle) /** NOTE : this is actually generating code for the Fields collections and not the PartitionPolicyFields (it's the same data just different collections - see implementations)*/
  WritePartitionPolicyFields (handle)
  WritePartitions (handle, handle)
  WriteQuery (handle)
  WriteTenantGroupMembers (handle)
  WriteTenantGroupMembersBuffer (handle, handle) /** NOTE : this is actually generating code for the Tenants and TenantGroups collections and not the tenantGroupMembers (it's the same data just different collections - see implementations)*/
  WriteToFile (IDataAdminSerializable, character, character)
  WriteToFile (IDataAdminSerializable, character, character, IPageRequest)
  LONGCHAR WriteToLongchar (IDataAdminSerializable, character) /** incomplete */
  WriteToMemptr (IDataAdminSerializable, memptr, character) /** incomplete */
  WriteToStream (IDataAdminSerializable, handle, character) /** incomplete */

Constructor Summary
  Options Name Purpose
  CodeWriter () /* define private variable mParentCreated as logical no-undo.*/

Property Summary
  Options Name Purpose
  OpenEdge.DataAdmin.Binding.IContextTree ContextTree
  LOGICAL Formatted


Method Detail
Top

OpenEdge.DataAdmin.Binding.IContextTree CreateContextTree ()

Returns OpenEdge.DataAdmin.Binding.IContextTree
 
Top

CHARACTER GetArea (character)

Parameters:
cvalue CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetAreaExpression (handle)

Parameters:
phbuffer HANDLE
 
Returns CHARACTER
 
Top

CHARACTER GetAuthenticationSystem (character)

Parameters:
cvalue CHARACTER
 
Returns CHARACTER
 
Top

HANDLE GetChildBuffer (handle, character)

/* we could have just used the dataset as of current, but this is more correct
since we want the buffer if it is a child
Parameters:
phBuffer HANDLE
 
pcname CHARACTER
 
Returns HANDLE
 
Top

HANDLE GetChildQuery (handle, character)

Parameters:
phBuffer HANDLE
 
pcname CHARACTER
 
Returns HANDLE
 
Top

HANDLE GetChildRelation (handle, character)

Parameters:
phBuffer HANDLE
 
pcname CHARACTER
 
Returns HANDLE
 
Top

CHARACTER GetCollectionClass (character)

Parameters:
pcBuffername CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetCollectionInstance (character)

Parameters:
pcBuffername CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetCollectionName (character)

Parameters:
pcBuffername CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetComment (handle, character, character)

/* Sun Oct 17 15:10:33 EDT 2010
Parameters:
phDs HANDLE
 
pcfile CHARACTER
 
pcpurpose CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetDate ()

Returns CHARACTER
 
Top

CHARACTER GetEntityClass (character)

Parameters:
pcBuffername CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetEntityInstance (character)

Parameters:
pcBuffername CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetEntityInterface (character)

Parameters:
pcBuffername CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetNameExpression (handle)

Parameters:
phBuffer HANDLE
 
Returns CHARACTER
 
Top

CHARACTER GetNote (handle)

Parameters:
phDs HANDLE
 
Returns CHARACTER
 
Top

HANDLE GetPartitionChangeQuery (handle, log)

/* creates a query with changed partitions
precheck all details
Parameters:
phbuffer HANDLE
 
plgrandparent LOGICAL
 
Returns HANDLE
 
Top

CHARACTER GetPolicyAreaExpression ()

Returns CHARACTER
 
Top

CHARACTER GetStateDefault (handle)

Purpose:
Notes:
Parameters:
phBuff HANDLE
 
Returns CHARACTER
 
Top

CHARACTER GetTable (character)

Parameters:
cvalue CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetTenantGroup (character)

Parameters:
cvalue CHARACTER
 
Returns CHARACTER
 
Top

LOGICAL HasPolicyPartitionChanges (handle)

Purpose:
Notes:
Parameters:
phbuffer HANDLE
 
Returns LOGICAL
 
Top

OpenEdge.DataAdmin.Binding.IContextTree Write (IDataAdminSerializable, character)

Parameters:
serializable IDataAdminSerializable
 
pcMode CHARACTER
 
Returns OpenEdge.DataAdmin.Binding.IContextTree
 
Top

writeAddToParent (handle)

Parameters:
hBuffer HANDLE
 
Top

WriteBuffer (handle)

Parameters:
hbuffer HANDLE
 
Top

WriteCdcChangeTable (handle)

Parameters:
hField HANDLE
 
Top

WriteCdcField (handle, handle)

Parameters:
hField HANDLE
 
hParent HANDLE
 
Top

WriteCdcFieldPolicies (handle)

Parameters:
pquery HANDLE
 
Top

WriteCdcIdentifyingField (handle)

Parameters:
hField HANDLE
 
Top

WriteCdcLevel (handle)

Parameters:
hField HANDLE
 
Top

WriteCdcState (handle)

Parameters:
hField HANDLE
 
Top

WriteCdcTable (character, character, character)

/* The CDC implementation requires owner name as well since the CDC ABL API supports PUB and non-PUB tables
Parameters:
tOwner CHARACTER
 
tName CHARACTER
 
bufferName CHARACTER
 
Top

WriteCode (handle)

Parameters:
h HANDLE
 
Top

WriteCreateInService (handle)

Parameters:
phBuff HANDLE
 
Top

WriteDefs (handle)

Parameters:
hDs HANDLE
 
Top

WriteErrorHandler ()

Top

WriteField (handle)

Parameters:
hField HANDLE
 
Top

WriteHeader (handle)

Parameters:
hDs HANDLE
 
Top

WriteInit ()

Top

WriteLocalIndexBuffer (handle, handle)

Parameters:
hparent HANDLE
 
pquery HANDLE
 
Top

WritePartitionBuffer (handle, handle)

Parameters:
hparent HANDLE
 
hbuffer HANDLE
 
Top

WritePartitionPolicyDetails (handle)

/* end method.
Parameters:
pquery HANDLE
 
Top

WritePartitionPolicyFieldBuffer (handle, handle)

Purpose: NOTE : this is actually generating code for the Fields collections
and not the PartitionPolicyFields
(it's the same data just different collections - see implementations)
Parameters:
hparent HANDLE
 
hbuffer HANDLE
 
Top

WritePartitionPolicyFields (handle)

Parameters:
phBuffer HANDLE
 
Top

WritePartitions (handle, handle)

Parameters:
phParent HANDLE
 
phquery HANDLE
 
Top

WriteQuery (handle)

Parameters:
pquery HANDLE
 
Top

WriteTenantGroupMembers (handle)

Parameters:
phBuffer HANDLE
 
Top

WriteTenantGroupMembersBuffer (handle, handle)

Purpose: NOTE : this is actually generating code for the Tenants and TenantGroups collections
and not the tenantGroupMembers
(it's the same data just different collections - see implementations)
Parameters:
hparent HANDLE
 
hbuffer HANDLE
 
Top

WriteToFile (IDataAdminSerializable, character, character)

Parameters:
serializable IDataAdminSerializable
 
pcFile CHARACTER
 
pcMode CHARACTER
 
Top

WriteToFile (IDataAdminSerializable, character, character, IPageRequest)

Parameters:
serializable IDataAdminSerializable
 
pcFile CHARACTER
 
pcMode CHARACTER
 
pageReq OpenEdge.DataAdmin.Rest.IPageRequest
 
Top

LONGCHAR WriteToLongchar (IDataAdminSerializable, character)

Purpose: incomplete
Parameters:
serializable IDataAdminSerializable
 
pcMode CHARACTER
 
Returns LONGCHAR
 
Top

WriteToMemptr (IDataAdminSerializable, memptr, character)

Purpose: incomplete
Parameters:
serializable IDataAdminSerializable
 
m MEMPTR
 
pcMode CHARACTER
 
Top

WriteToStream (IDataAdminSerializable, handle, character)

Purpose: incomplete
Parameters:
serializable IDataAdminSerializable
 
phStream HANDLE
 
pcMode CHARACTER
 


Constructor Detail
Top

CodeWriter ()

/* define private variable mParentCreated as logical no-undo.


Property Detail
Top

OpenEdge.DataAdmin.Binding.IContextTree ContextTree

Returns OpenEdge.DataAdmin.Binding.IContextTree
 
Top

LOGICAL Formatted

Returns LOGICAL