Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > EnsLib.RecordMap.RecordMap
Private  Storage   

EnsLib.RecordMap.RecordMap


class EnsLib.RecordMap.RecordMap extends
%RegisteredObject

Base class for RecordMap parsers, which are generated based on the content of RecordMaps

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 22 1


Summary


Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject DeleteRecordMap Escape Exists
GetGeneratedClasses GetObject GetRecordIdentifier GetRecordType
ListClose ListExecute ListFetch PutObject
SampleParse checkFixedWidthChunk checkMerge chunkRecord
escapeChars getChars getIdentifier getType
readLabel


Parameters


• parameter OBJECTNAME;

Methods


• classmethod DeleteRecordMap(pRecordMap As %String = "", pRemoveTargetClass As %Boolean = 0, pRemoveTargetExtent As %Boolean = 0) as %Status
Delete an existing RecordMap, and optionally delete the target class definition and the target class's extent. The option to remove the extent is only evaluated if the target class is also being deleted, otherwise the option is ignored.
• classmethod Escape(pData As %String, pSeps As %List, pEscaping As %String, pEscSequence As %String) as %String
• classmethod Exists(name As %String) as %Boolean
Check for the existence of a specific RecordMap.
• classmethod GetGeneratedClasses(Output pClasses As %String) as %Status
• abstract classmethod GetObject(pStream As %IO.DeviceStream, Output pObject As %RegisteredObject, pTimeout As %Numeric = -1, ByRef pLookAhead As %String = "", pLabelFound As %Boolean = 0) as %Status
Method to retrieve a record from a stream or device. This method will be generated based on the structure of the RecordMap. For testing purposes, a file name may be passed in the pStream argument.
• abstract private classmethod GetRecord(pStream As %IO.DeviceStream, pObject As %RegisteredObject, pGetTopFields As %Boolean, pTimeout As %Numeric, pLookAhead As %String = "", pLabelFound As %Boolean = 0) as %Status
Internal helper method to perform parse of incoming data
• classmethod GetRecordIdentifier(pRecordMap As %String = "") as %String
• classmethod GetRecordType(pRecordMap As %String = "") as EnsLib.RecordMap.Model.DataType.RecordType
• classmethod ListClose(ByRef qHandle As %Binary) as %Status
• classmethod ListExecute(ByRef qHandle As %Binary) as %Status
• classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• abstract classmethod PutObject(pStream As %IO.DeviceStream, pObject As %RegisteredObject, pFlush As %Boolean = 1, ByRef pPadArray As %String) as %Status
Method to write a record to a stream or device. This method will be generated based on the structure of the RecordMap. For testing purposes, a file name may be passed in the pStream argument.
• abstract private classmethod PutRecord(pStream As %IO.DeviceStream, pObject As %RegisteredObject, pHasTopFields As %Boolean) as %Status
Internal helper method to output object to a stream
• classmethod SampleParse(pRecordMap As %String, pSampleFile As %String, Output pOutputHTML As %Stream.TmpCharacter, pGetTopFields As %Boolean = 1, pLabelFound As %Boolean = 0, pMaxRecords As %Integer = 3) as %Status
This functionality has been moved to EnsLib.RecordMap.Utils, which is invoked from this entry point.
• classmethod checkFixedWidthChunk(ByRef pStatus As %Status, ByRef pNewChunk, ByRef pCurrChunk, ByRef pRecordData, ByRef pCurrString, ByRef pCurrLen, ByRef pCurrPos, pWidth As %Integer, pSep As %String = "", pTrailing As %String = "", pFieldName As %String = "", pAllowEarlyTerminator As %Integer = 0) as %String
Helper method for parsing chunked fixed width records
• classmethod checkMerge(ByRef pCurrChunk, ByRef pRecordData, ByRef pCurrString, pCurrSep, ByRef pCurrPiece, ByRef pEscaping)
Helper method to ensure delimited data spread over multiple chunks is correctly reconstituted.
• classmethod chunkRecord(pStream As %IO.DeviceStream, Output pRecordChunk As %Integer, Output pCharCount As %Integer, pMaxLen As %Integer = "", pTimeout As %Numeric = -1, ByRef pRecordTerminator As %String = "", pLabel As %String = "", ByRef pExtra As %String = "", pQuoteChar As %String = "") as %Status
Chunk the incoming data into pieces while looking for the supplied terminator and/or maximum length.
• classmethod escapeChars(pChars As %String, ByRef pBreaks As %Integer = 0, pIgnoreSpaces As %Boolean = 0) as %String
Escape characters for HTML output
• classmethod getChars(pChars As %String) as %String
Get actual characters from an internal string representation.
• abstract classmethod getIdentifier() as %String
• abstract classmethod getType() as EnsLib.RecordMap.Model.DataType.RecordType
• classmethod readLabel(pStream As %IO.DeviceStream, pLabel As %String, pTimeout As %Numeric = -1, ByRef pExtra As %String = "") as %Status
Read the supplied label from the stream.

Queries


• query List()
Selects name As %String, modified As %TimeStamp, size As %Integer
List the existing RecordMap definitions.