Namespace: OpenEdge.Core
Type: Class DataTypeHelper
Parent Classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object


Copyright (c) 2013, 2015-2016, 2019, 2021, 2023. by Progress Software Corporation. All rights reserved.
File:DataTypeHelper
Author(s):pjudge
Created:Thu Apr 09 15:21:48 EDT 2015
Purpose: This method changes a type description or 'mask' if it's an array to
return the base datatype and the word Extent, otherwise it returns
the datatype enetered. This allows the user to find out if a particular
datatype is an array or not through the isArray method.



Method Summary
  Options Name Purpose
  CHARACTER GetMask (DataTypeEnum) /** This method changes a type description or 'mask' if it's an array to return the base datatype and the word Extent, otherwise it returns the datatype enetered. This allows the user to find out if a particular datatype is an array or not through the isArray method. @param DataTypeEnum The ABL data type @return Character The mask of the data type. */
  LOGICAL IsArray (DataTypeEnum) /** Check to see if the data type is an array so user knows how to handle extents. e.g. CharacterArray - Character is primitive, but the array type makes it so the user must handle the extents to get the character data. @param DataTypeEnum The ABL data type @return logical Is the datatype an array. */
  LOGICAL IsPrimitive (DataTypeEnum) /** Check to see if the data type is a primitive datatype. @param DataTypeEnum The ABL data type @return logical Is the datatype a primitive. */
  CHARACTER ToXmlSchemaType (DataTypeEnum) /** Mapping from ABL data type to XML Schema supported data types. Taken from the Working With XML book from the documentation set. Note that the converse is not supported, since there are multiple ABL types that map to a single XML schema type. @param DataTypeEnum The ABL data type @return character The XML data type. */

Method Detail
Top

CHARACTER GetMask (DataTypeEnum)

Purpose: This method changes a type description or 'mask' if it's an array to
return the base datatype and the word Extent, otherwise it returns
the datatype enetered. This allows the user to find out if a particular
datatype is an array or not through the isArray method.
Parameters:
poDataType OpenEdge.Core.DataTypeEnum
 
Returns CHARACTER
  Character The mask of the data type.
Top

LOGICAL IsArray (DataTypeEnum)

Purpose: Check to see if the data type is an array so user knows how to handle extents.
e.g. CharacterArray - Character is primitive, but the array type makes it so
the user must handle the extents to get the character data.
Parameters:
poDataType OpenEdge.Core.DataTypeEnum
 
Returns LOGICAL
  logical Is the datatype an array.
Top

LOGICAL IsPrimitive (DataTypeEnum)

Purpose: Check to see if the data type is a primitive datatype.
Parameters:
poDataType OpenEdge.Core.DataTypeEnum
 
Returns LOGICAL
  logical Is the datatype a primitive.
Top

CHARACTER ToXmlSchemaType (DataTypeEnum)

Purpose: Mapping from ABL data type to XML Schema supported data types. Taken from
the Working With XML book from the documentation set.
Note that the converse is not supported, since there are multiple ABL types
that map to a single XML schema type.
Parameters:
poDataType OpenEdge.Core.DataTypeEnum
 
Returns CHARACTER
  character The XML data type.