EnsLib.RecordMap.RecordMap
class EnsLib.RecordMap.RecordMap extends %Library.RegisteredObject
Base class for RecordMap parsers, which are generated based on the content of RecordMapsMethod Inventory
- DeleteRecordMap()
- Escape()
- Exists()
- GetGeneratedClasses()
- GetObject()
- GetRecordIdentifier()
- GetRecordType()
- ListClose()
- ListExecute()
- ListFetch()
- PutObject()
- getIdentifier()
- getType()
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
Check for the existence of a specific RecordMap.
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.
classmethod GetRecordType(pRecordMap As %String = "") as EnsLib.RecordMap.Model.DataType.RecordType
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 classmethod getIdentifier() as %String
abstract classmethod getType() as EnsLib.RecordMap.Model.DataType.RecordType
Queries
query List()
List the existing RecordMap definitions.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
Subclasses
- Demo.ComplexMap.Semester.ClassInfo
- Demo.ComplexMap.Semester.SemesterHeader
- Demo.ComplexMap.Semester.Student
- Demo.ComplexMap.SemesterFixed.ClassInfo
- Demo.ComplexMap.SemesterFixed.Semester
- Demo.ComplexMap.SemesterFixed.Student
- Demo.ComplexMap.Summary.SemesterHeader
- Demo.ComplexMap.Summary.Student
- Demo.RecordMap.Map.Delimited
- Demo.RecordMap.Map.FixedWidth
- Demo.RecordMapBatch.Map.TrainDataIn
- Demo.RecordMapBatch.Map.TrainDataOut