Namespace: OpenEdge.DataAdmin.DataSource
Type: Class IndexDataReader
Parent Classes:
Inherits: OpenEdge.DataAdmin.DataSource.DataSource


/* *********************************************************
/* Copyright (c) 2014 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:IndexData
Author(s):hdaniels
Created:Mon Nov 25 21:49:11 EST 2013
Purpose:
Notes:



Method Summary
  Options Name Purpose
  CHARACTER ColumnExpression (character, character, character) /* return source columns for query mapping (part of IQueryMap interface used by QueryString to map query */
  CHARACTER ColumnSource (character) /* don't access map for anything (not attached ) */
  LOGICAL Fill ()
  FillBuffer (handle, handle[])
  FillRangeBuffer (handle, handle[])
  FillRow (character[], handle[])
  CHARACTER GetFieldExpression (character, character[], character[], integer)
  CHARACTER GetIndexFields (character, character, integer)
  CHARACTER GetPropertyValue (handle, character, integer, handle[])
  CHARACTER GetValueForName (character, character) /** The _Partition-Policy-Name must conform to the same rules as required of Progress table, index and field names. Namely the name is limited to the ASCII character set. It must start with a letter (although unlike Progress table names it can start with an _). The name cannot contain an embedded space, punctuation or the @ character.*/
  CHARACTER GetValues (handle[])
  LOGICAL Prepare (handle, character, character, character)

Constructor Summary
  Options Name Purpose
  IndexDataReader ()

Property Summary
  Options Name Purpose
  OpenEdge.DataAdmin.DataSource.DataSourceUtil DataSourceUtil
  CHARACTER DetailNameSubstituteBase
  CHARACTER DetailNameSubstituteNames
  CHARACTER FieldList
  CHARACTER FieldNames
  LOGICAL HasRange
  CHARACTER IndexName
  INTEGER NumFields
  CHARACTER PartitionPolicyName
  CHARACTER TableName
  CHARACTER UseIndex


Method Detail
Top

CHARACTER ColumnExpression (character, character, character)

/* return source columns for query mapping
(part of IQueryMap interface used by QueryString to map query
Parameters:
pcColumn CHARACTER
 
pcoperator CHARACTER
 
pcvalue CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER ColumnSource (character)

/* don't access map for anything (not attached )
Parameters:
pcColumn CHARACTER
 
Returns CHARACTER
 
Top

LOGICAL Fill ()

Returns LOGICAL
 
Top

FillBuffer (handle, handle[])

Parameters:
phdatabuffer HANDLE
 
phFieldHandles HANDLE
 
Top

FillRangeBuffer (handle, handle[])

Parameters:
phdatabuffer HANDLE
 
phFieldHandles HANDLE
 
Top

FillRow (character[], handle[])

Parameters:
pcvalues CHARACTER
 
phfldhandles HANDLE
 
Top

CHARACTER GetFieldExpression (character, character[], character[], integer)

Parameters:
pcTable CHARACTER
 
pcFields CHARACTER
 
pcValues CHARACTER
 
pilevel INTEGER
 
Returns CHARACTER
 
Top

CHARACTER GetIndexFields (character, character, integer)

Parameters:
pcTable CHARACTER
 
pcIndex CHARACTER
 
pimax INTEGER
 
Returns CHARACTER
 
Top

CHARACTER GetPropertyValue (handle, character, integer, handle[])

Parameters:
phbuffer HANDLE
 
pcFld CHARACTER
 
pinum INTEGER
 
phfldhandles HANDLE
 
Returns CHARACTER
 
Top

CHARACTER GetValueForName (character, character)

Purpose: The _Partition-Policy-Name must conform to the same rules as required of Progress table, index and field names.
Namely the name is limited to the ASCII character set. It must start with a letter
(although unlike Progress table names it can start with an _).
The name cannot contain an embedded space, punctuation or the @ character.
Parameters:
pcvalue CHARACTER
 
pcdatatype CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetValues (handle[])

Parameters:
pfieldhandles HANDLE
 
Returns CHARACTER
 
Top

LOGICAL Prepare (handle, character, character, character)

Parameters:
phBuffer HANDLE
 
pcBaseQuery CHARACTER
 
pcTargetQuery CHARACTER
 
pcJoin CHARACTER
 
Returns LOGICAL
 


Constructor Detail
Top

IndexDataReader ()



Property Detail
Top

OpenEdge.DataAdmin.DataSource.DataSourceUtil DataSourceUtil

Returns OpenEdge.DataAdmin.DataSource.DataSourceUtil
 
Top

CHARACTER DetailNameSubstituteBase

Returns CHARACTER
 
Top

CHARACTER DetailNameSubstituteNames

Returns CHARACTER
 
Top

CHARACTER FieldList

Returns CHARACTER
 
Top

CHARACTER FieldNames

Returns CHARACTER
 
Top

LOGICAL HasRange

Returns LOGICAL
 
Top

CHARACTER IndexName

Returns CHARACTER
 
Top

INTEGER NumFields

Returns INTEGER
 
Top

CHARACTER PartitionPolicyName

Returns CHARACTER
 
Top

CHARACTER TableName

Returns CHARACTER
 
Top

CHARACTER UseIndex

Returns CHARACTER