Property methods: TopIdDisplayToLogical(), TopIdGet(), TopIdGetStored(), TopIdIsValid(), TopIdLogicalToDisplay(), TopIdLogicalToOdbc(), TopIdNormalize(), TopIdSet()
DBMTables.Files
persistent class DBMTables.Files extends %Library.Persistent
SQL Table Name: DBMTables.Files
This class stores one record for each .XML file on the search path, except for the SET files. It also stores on record for each .XML file listed via the EXTRA option. For general comments, see DBMTables.Utils.Property Inventory
Method Inventory
- AddExtraSources()
- CreateComponentsForNavPages()
- ProcessDirectory()
- ProcessFileNew()
- Rebuild()
- Update()
- WriteList()
Properties
property DocBookId as %String (MAXLEN = 200);
id of or etc.
Displayed in table; used as filter.
Property methods: DocBookIdDisplayToLogical(), DocBookIdGet(), DocBookIdGetStored(), DocBookIdIsValid(), DocBookIdLogicalToDisplay(), DocBookIdLogicalToOdbc(), DocBookIdNormalize(), DocBookIdSet()
property Extra as %Boolean [ InitialExpression = 0 ];
Indicates if this file is "extra"
Property methods: ExtraDisplayToLogical(), ExtraGet(), ExtraGetStored(), ExtraIsValid(), ExtraLogicalToDisplay(), ExtraNormalize(), ExtraSet()
property Filename as %String (MAXLEN = 200);
Complete path and filename. Displayed above table.
Property methods: FilenameDisplayToLogical(), FilenameGet(), FilenameGetStored(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()
property HavePDF as %Boolean [ InitialExpression = 0 ];
Indicates if there is a corresponding PDF for this item (in Perforce); applies only to top-level items
Property methods: HavePDFDisplayToLogical(), HavePDFGet(), HavePDFGetStored(), HavePDFIsValid(), HavePDFLogicalToDisplay(), HavePDFNormalize(), HavePDFSet()
property LoadType as %String;
Either "book", "article", or "component".
Not displayed but used to control behavior.
Property methods: LoadTypeDisplayToLogical(), LoadTypeGet(), LoadTypeGetStored(), LoadTypeIsValid(), LoadTypeLogicalToDisplay(), LoadTypeLogicalToOdbc(), LoadTypeNormalize(), LoadTypeSet()
property Remap as %String (MAXLEN = 200);
Remap value of this DocBook id, if available in the database.
Property methods: RemapDisplayToLogical(), RemapGet(), RemapGetStored(), RemapIsValid(), RemapLogicalToDisplay(), RemapLogicalToOdbc(), RemapNormalize(), RemapSet()
property ShortFilename as %String (MAXLEN = 200);
Short filename. Shown in secondary table.
Property methods: ShortFilenameDisplayToLogical(), ShortFilenameGet(), ShortFilenameGetStored(), ShortFilenameIsValid(), ShortFilenameLogicalToDisplay(), ShortFilenameLogicalToOdbc(), ShortFilenameNormalize(), ShortFilenameSet()
property Size as %Integer;
Property methods: SizeDisplayToLogical(), SizeGet(), SizeGetStored(), SizeIsValid(), SizeLogicalToDisplay(), SizeNormalize(), SizeSet()
property Title as %String (MAXLEN = 200);
Title of this DocBook id, if available in the database.
Displayed above the table.
Property methods: TitleDisplayToLogical(), TitleGet(), TitleGetStored(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()
property TopId as %String (MAXLEN = 200);
id of or to which this file belongs.
property TopLevel as %Boolean [ InitialExpression = 0 ];
Indicates if this file is top-level (set, book, or article) or a component
Property methods: TopLevelDisplayToLogical(), TopLevelGet(), TopLevelGetStored(), TopLevelIsValid(), TopLevelLogicalToDisplay(), TopLevelNormalize(), TopLevelSet()
Methods
classmethod AddExtraSources(verbose As %Integer = 0)
For this method, verbose is 0, 1, or 2.
classmethod ProcessDirectory(fulldirectory As %String = "", isExtra As %Boolean = "", verbose As %Integer = 0)
classmethod ProcessFileNew(filename As %String = "", isExtra As %Boolean = "", verbose As %Integer = 0)
classmethod Rebuild(verbose As %Integer = 0)
For this method, verbose is 0, 1, or 2.
For this method, verbose is 0, 1, or 2.
classmethod Update(DocBookId As %String)
Update a record in this cache. Use this after loading or removing a book or article file.
Indexes
index (DocBookIdIdx on DocBookId);
Index methods: DocBookIdIdxExists()
index (FilenameIdx on Filename);
Index methods: FilenameIdxExists()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (LoadTypeIdx on LoadType);
Index methods: LoadTypeIdxExists()
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
Storage
Storage Model: CacheStorage (DBMTables.Files)
^DBMTables.FilesD(ID) | = | %%CLASSNAME
DocBookId
Type
Filename
ShortFilename
Title
Remap
Extra
TopLevel
Size
TopId
HavePDF
LoadType
|