Home > Class Reference > ENSLIB namespace > %MV.File

%MV.File

class %MV.File extends %Library.RegisteredObject

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property %Account as %String;
Property methods: %AccountDisplayToLogical(), %AccountGet(), %AccountIsValid(), %AccountLogicalToDisplay(), %AccountLogicalToOdbc(), %AccountNormalize(), %AccountSet()
property %BSCAN as %String [ MultiDimensional ];
Simpler index functions such as BSCAN, expect the file variable to track the last index access. In order to allow this, we store these in an array, subscripted by index name. The top level is used to track when BSCAN walks over the global itself, instead of an index.
Property methods: %BSCANDisplayToLogical(), %BSCANGet(), %BSCANIsValid(), %BSCANLogicalToDisplay(), %BSCANLogicalToOdbc(), %BSCANNormalize(), %BSCANSet()
property %COSName as %String;
Property methods: %COSNameDisplayToLogical(), %COSNameGet(), %COSNameIsValid(), %COSNameLogicalToDisplay(), %COSNameLogicalToOdbc(), %COSNameNormalize(), %COSNameSet()
property %CasePreserveName as %String;
Case preserving form of file name
Property methods: %CasePreserveNameDisplayToLogical(), %CasePreserveNameGet(), %CasePreserveNameIsValid(), %CasePreserveNameLogicalToDisplay(), %CasePreserveNameLogicalToOdbc(), %CasePreserveNameNormalize(), %CasePreserveNameSet()
property %ClassName as %String;
Property methods: %ClassName(), %ClassNameDisplayToLogical(), %ClassNameGet(), %ClassNameIsValid(), %ClassNameLogicalToDisplay(), %ClassNameLogicalToOdbc(), %ClassNameNormalize(), %ClassNameSet(), %ClassNamespaceDisplayToLogical(), %ClassNamespaceGet(), %ClassNamespaceIsValid(), %ClassNamespaceLogicalToDisplay(), %ClassNamespaceLogicalToOdbc(), %ClassNamespaceNormalize(), %ClassNamespaceSet()
property %ClassNamespace as %String;
Namespace for Class
Property methods: %ClassNamespaceDisplayToLogical(), %ClassNamespaceGet(), %ClassNamespaceIsValid(), %ClassNamespaceLogicalToDisplay(), %ClassNamespaceLogicalToOdbc(), %ClassNamespaceNormalize(), %ClassNamespaceSet()
property %DictFlag as %Integer [ InitialExpression = 0 ];
Property methods: %DictFlagDisplayToLogical(), %DictFlagGet(), %DictFlagIsValid(), %DictFlagLogicalToDisplay(), %DictFlagNormalize(), %DictFlagSet()
property %FileName as %String;
Property methods: %FileNameDisplayToLogical(), %FileNameGet(), %FileNameIsValid(), %FileNameLogicalToDisplay(), %FileNameLogicalToOdbc(), %FileNameNormalize(), %FileNameSet()
property %FireTriggers as %Integer [ InitialExpression = 0 ];
This boolean flag indicates that the MVFIO routines must process trigger calls when it is set to TRUE. The trigger routine itself will clear this flag to call back in to MVFIO to process the operation then set it back to TRUE when the operation is complete. This allows Pre and Post operations to exist for an MVFIO function without interfering with the indexing routine calls.
Property methods: %FireTriggersDisplayToLogical(), %FireTriggersGet(), %FireTriggersIsValid(), %FireTriggersLogicalToDisplay(), %FireTriggersNormalize(), %FireTriggersSet()
property %Global as %String;
Property methods: %GlobalDisplayToLogical(), %GlobalGet(), %GlobalIsValid(), %GlobalLogicalToDisplay(), %GlobalLogicalToOdbc(), %GlobalNormalize(), %GlobalSet()
property %IOTable as %String;
IO table used for reading or writing to the files in this directory
Property methods: %IOTableDisplayToLogical(), %IOTableGet(), %IOTableIsValid(), %IOTableLogicalToDisplay(), %IOTableLogicalToOdbc(), %IOTableNormalize(), %IOTableSet()
property %IndColl as %String;
$LIST of index collations that can be used by index functions
Property methods: %IndCollDisplayToLogical(), %IndCollGet(), %IndCollIsValid(), %IndCollLogicalToDisplay(), %IndCollLogicalToOdbc(), %IndCollNormalize(), %IndCollSet()
property %IndFlag as %Boolean [ InitialExpression = 0 ];
Flag to determine if index names/collations has been loaded yet
Property methods: %IndFlagDisplayToLogical(), %IndFlagGet(), %IndFlagIsValid(), %IndFlagLogicalToDisplay(), %IndFlagNormalize(), %IndFlagSet()
property %IndMV as %String;
String of index MV flags (0->S,1->M) that can be used by index functions
Property methods: %IndMVDisplayToLogical(), %IndMVGet(), %IndMVIsValid(), %IndMVLogicalToDisplay(), %IndMVLogicalToOdbc(), %IndMVNormalize(), %IndMVSet()
property %IndNames as %String;
$LIST of index names that can be used by index functions
Property methods: %IndNamesDisplayToLogical(), %IndNamesGet(), %IndNamesIsValid(), %IndNamesLogicalToDisplay(), %IndNamesLogicalToOdbc(), %IndNamesNormalize(), %IndNamesSet()
property %IndexCollation as %Integer [ InitialExpression = 0 ];
A select list can represent an index. An index stores the actual keys as oppposed to the key values returned by READNEXT in collated encoding sequence such as MV R or SPACE (equivlant to MV L) etc. This property defines the collation in use for the index.
Property methods: %IndexCollationDisplayToLogical(), %IndexCollationGet(), %IndexCollationIsValid(), %IndexCollationLogicalToDisplay(), %IndexCollationNormalize(), %IndexCollationSet()
property %IndexName as %String;
When the file variable is produced as a result of OPENINDEX then the index that was opened is stored here for future use by any select lists. Note that at the moment index storage is restricted to the default of ^INDEXGLOBAL("indexName",... and we may need to review this, though it is unlikely to be an issue
Property methods: %IndexNameDisplayToLogical(), %IndexNameGet(), %IndexNameIsValid(), %IndexNameLogicalToDisplay(), %IndexNameLogicalToOdbc(), %IndexNameNormalize(), %IndexNameSet()
property %IndexRoutine as %String;
Property methods: %IndexRoutineDisplayToLogical(), %IndexRoutineGet(), %IndexRoutineIsValid(), %IndexRoutineLogicalToDisplay(), %IndexRoutineLogicalToOdbc(), %IndexRoutineNormalize(), %IndexRoutineSet()
property %IndexType as %Integer [ InitialExpression = 0 ];
Property methods: %IndexTypeDisplayToLogical(), %IndexTypeGet(), %IndexTypeIsValid(), %IndexTypeLogicalToDisplay(), %IndexTypeNormalize(), %IndexTypeSet()
property %IsBinary as %Boolean [ InitialExpression = 0 ];
Property methods: %IsBinaryDisplayToLogical(), %IsBinaryGet(), %IsBinaryIsValid(), %IsBinaryLogicalToDisplay(), %IsBinaryNormalize(), %IsBinarySet()
property %IsTranslated as %Boolean [ InitialExpression = 1 ];
Property methods: %IsTranslatedDisplayToLogical(), %IsTranslatedGet(), %IsTranslatedIsValid(), %IsTranslatedLogicalToDisplay(), %IsTranslatedNormalize(), %IsTranslatedSet()
property %LockName as %String;