DBMTables.TOC
persistent class DBMTables.TOC extends %Library.Persistent
SQL Table Name: DBMTables.TOC
This class stores one record for each TOC entry in the database. For general comments, see DBMTables.Utils.Property Inventory
- DocBookId
- Document
- IdIsGenerated
- IdIsOK
- NavParents
- Parent
- Rank
- RankInherited
- ShortTitle
- SourceFile
- SubtitleNice
- TagsInherited
- Title
- TitleNice
- TitleRaw
- UnitLevel
- UnitNumbering
- UnitType
- X
- extraTags
- product
Method Inventory
Properties
property DocBookId as %String (MAXLEN = 200);
DocBookId of the TOC entry
Property methods: DocBookIdDisplayToLogical(), DocBookIdGet(), DocBookIdGetStored(), DocBookIdIsValid(), DocBookIdLogicalToDisplay(), DocBookIdLogicalToOdbc(), DocBookIdNormalize(), DocBookIdSet()
property Document as %String (MAXLEN = 200);
DocBookId of parent book or article.
Property methods: DocumentDisplayToLogical(), DocumentGet(), DocumentGetStored(), DocumentIsValid(), DocumentLogicalToDisplay(), DocumentLogicalToOdbc(), DocumentNormalize(), DocumentSet()
property IdIsGenerated as %Boolean;
true if this id appears to be a generated one
Property methods: IdIsGeneratedDisplayToLogical(), IdIsGeneratedGet(), IdIsGeneratedGetStored(), IdIsGeneratedIsValid(), IdIsGeneratedLogicalToDisplay(), IdIsGeneratedNormalize(), IdIsGeneratedSet()
property IdIsOK as %Boolean;
Property methods: IdIsOKDisplayToLogical(), IdIsOKGet(), IdIsOKGetStored(), IdIsOKIsValid(), IdIsOKLogicalToDisplay(), IdIsOKNormalize(), IdIsOKSet()
Property methods: NavParentsDisplayToLogical(), NavParentsGet(), NavParentsGetStored(), NavParentsIsValid(), NavParentsLogicalToDisplay(), NavParentsLogicalToOdbc(), NavParentsNormalize(), NavParentsSet()
property Parent as %String (MAXLEN = 200);
DocBookId of the parent heading.
Property methods: ParentDisplayToLogical(), ParentGet(), ParentGetStored(), ParentIsValid(), ParentLogicalToDisplay(), ParentLogicalToOdbc(), ParentNormalize(), ParentSet()
property Rank as %Numeric;
Property methods: RankDisplayToLogical(), RankGet(), RankGetStored(), RankIsValid(), RankLogicalToDisplay(), RankNormalize(), RankSet()
property RankInherited as %Boolean [ Transient ];
Property methods: RankInheritedCompute(), RankInheritedDisplayToLogical(), RankInheritedGet(), RankInheritedIsValid(), RankInheritedLogicalToDisplay(), RankInheritedNormalize(), RankInheritedSQLCompute(), RankInheritedSet(), RankInheritedSetT()
property ShortTitle (MAXLEN = 200);
Property methods: ShortTitleDisplayToLogical(), ShortTitleGet(), ShortTitleGetStored(), ShortTitleIsValid(), ShortTitleLogicalToDisplay(), ShortTitleLogicalToOdbc(), ShortTitleNormalize(), ShortTitleSet()
property SourceFile as %String (MAXLEN = 200);
Displayed in table; used as filter.
Property methods: SourceFileDisplayToLogical(), SourceFileGet(), SourceFileGetStored(), SourceFileIsValid(), SourceFileLogicalToDisplay(), SourceFileLogicalToOdbc(), SourceFileNormalize(), SourceFileSet()
property SubtitleNice as %String (MAXLEN = 5000);
Property methods: SubtitleNiceDisplayToLogical(), SubtitleNiceGet(), SubtitleNiceGetStored(), SubtitleNiceIsValid(), SubtitleNiceLogicalToDisplay(), SubtitleNiceLogicalToOdbc(), SubtitleNiceNormalize(), SubtitleNiceSet()
property TagsInherited as %Boolean [ Transient ];
Property methods: TagsInheritedCompute(), TagsInheritedDisplayToLogical(), TagsInheritedGet(), TagsInheritedIsValid(), TagsInheritedLogicalToDisplay(), TagsInheritedNormalize(), TagsInheritedSQLCompute(), TagsInheritedSet(), TagsInheritedSetT()
property Title as %String (MAXLEN = 200);
TOC entry - Converted from HTML and padded with leading spaces
Property methods: TitleDisplayToLogical(), TitleGet(), TitleGetStored(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()
property TitleNice as %String (MAXLEN = 200);
Converted from HTML
Property methods: TitleNiceDisplayToLogical(), TitleNiceGet(), TitleNiceGetStored(), TitleNiceIsValid(), TitleNiceLogicalToDisplay(), TitleNiceLogicalToOdbc(), TitleNiceNormalize(), TitleNiceSet()
property TitleRaw as %String (MAXLEN = 200);
Property methods: TitleRawDisplayToLogical(), TitleRawGet(), TitleRawGetStored(), TitleRawIsValid(), TitleRawLogicalToDisplay(), TitleRawLogicalToOdbc(), TitleRawNormalize(), TitleRawSet()
property UnitLevel as %Integer;
Numeric level of child unit (0, 1, 2, etc.)
Property methods: UnitLevelDisplayToLogical(), UnitLevelGet(), UnitLevelGetStored(), UnitLevelIsValid(), UnitLevelLogicalToDisplay(), UnitLevelNormalize(), UnitLevelSet()
property UnitNumbering as %String (MAXLEN = 200);
Hierarchical numbering of child unit
Property methods: UnitNumberingDisplayToLogical(), UnitNumberingGet(), UnitNumberingGetStored(), UnitNumberingIsValid(), UnitNumberingLogicalToDisplay(), UnitNumberingLogicalToOdbc(), UnitNumberingNormalize(), UnitNumberingSet()
property UnitType as %String (MAXLEN = 200);
Type of child unit (chapter, sect1, etc.
Property methods: UnitTypeDisplayToLogical(), UnitTypeGet(), UnitTypeGetStored(), UnitTypeIsValid(), UnitTypeLogicalToDisplay(), UnitTypeLogicalToOdbc(), UnitTypeNormalize(), UnitTypeSet()
property X as %Boolean [ Transient ];
Property methods: XCompute(), XDisplayToLogical(), XGet(), XIsValid(), XLogicalToDisplay(), XNormalize(), XSQLCompute(), XSet(), XSetT()
property extraTags as %String (MAXLEN = 200);
Any extra tags associated with this block.
We will use this information to restrict search by tags
Property methods: extraTagsDisplayToLogical(), extraTagsGet(), extraTagsGetStored(), extraTagsIsValid(), extraTagsLogicalToDisplay(), extraTagsLogicalToOdbc(), extraTagsNormalize(), extraTagsSet()
property product as %String;
The product this block belongs to, based on the arch attribute of the containing book or article.
We will use this information to restrict search by product.
Property methods: productDisplayToLogical(), productGet(), productGetStored(), productIsValid(), productLogicalToDisplay(), productLogicalToOdbc(), productNormalize(), productSet()
Methods
Exports records from this table to a JSON file
Exports records from this table to a CSV file. Returns the name of the exported file.
Exports records from this table to a JSON file
classmethod GenerateXMLReport(verbose As %Boolean = 0)
verbose can be 0, 1, 2, or 3
Given an book or article ID, process it, and optionally show its full table of contents.
Indexes
index ($TOC on ) [Extent, Type = bitmap];
index (DocBookIdIdx on DocBookId);
Index methods: DocBookIdIdxExists()
index (DocumentIdx on Document);
Index methods: DocumentIdxExists()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (IdIsGeneratedIdx on IdIsGenerated);
Index methods: IdIsGeneratedIdxExists()
index (ParentIdx on Parent);
Index methods: ParentIdxExists()
index (RankIdx on Rank) [Type = bitmap];
index (TitleIdx on Title);
Index methods: TitleIdxExists()
index (UnitLevelIdx on UnitLevel);
Index methods: UnitLevelIdxExists()
index (UnitTypeIdx on UnitType);
Index methods: UnitTypeIdxExists()
index (extraTagsIdx on extraTags);
Index methods: extraTagsIdxExists()
index (productIdx on product);
Index methods: productIdxExists()
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %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()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
Storage
Storage Model: Storage (DBMTables.TOC)
^DBMTables.TOCD(ID) |
= | %%CLASSNAME
DocBookId
Parent
Document
Title
TitleRaw
TitleNice
SubtitleNice
UnitType
UnitLevel
UnitNumbering
IdIsGenerated
IdIsOK
product
extraTags
Rank
NavParents
ShortTitle
SourceFile
|