Skip to main content

DBMTables.Pages

persistent class DBMTables.Pages extends %Library.Persistent

SQL Table Name: DBMTables.Pages

This class stores one record for stand-alone doc page. For general comments, see DBMTables.Utils.

Property Inventory

Method Inventory

Parameters

parameter WORDSPERMINUTE = 160;

Properties

property DescIsGenerated as %Boolean;
Property methods: DescIsGeneratedDisplayToLogical(), DescIsGeneratedGet(), DescIsGeneratedGetStored(), DescIsGeneratedIsValid(), DescIsGeneratedLogicalToDisplay(), DescIsGeneratedNormalize(), DescIsGeneratedSet()
property DescLength as %Integer;
Property methods: DescLengthDisplayToLogical(), DescLengthGet(), DescLengthGetStored(), DescLengthIsValid(), DescLengthLogicalToDisplay(), DescLengthNormalize(), DescLengthSet()
property Description as %String);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
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 MinutesToRead as %Integer [ Calculated ];
Property methods: MinutesToReadCompute(), MinutesToReadDisplayToLogical(), MinutesToReadGet(), MinutesToReadIsValid(), MinutesToReadLogicalToDisplay(), MinutesToReadNormalize(), MinutesToReadSQLCompute()
property MinutesToRead2 as %Integer [ Calculated ];
Property methods: MinutesToRead2Compute(), MinutesToRead2DisplayToLogical(), MinutesToRead2Get(), MinutesToRead2IsValid(), MinutesToRead2LogicalToDisplay(), MinutesToRead2Normalize(), MinutesToRead2SQLCompute()
Property methods: NavParentCountDisplayToLogical(), NavParentCountGet(), NavParentCountGetStored(), NavParentCountIsValid(), NavParentCountLogicalToDisplay(), NavParentCountNormalize(), NavParentCountSet()
Property methods: NavParentsDisplayToLogical(), NavParentsGet(), NavParentsGetStored(), NavParentsIsValid(), NavParentsLogicalToDisplay(), NavParentsLogicalToOdbc(), NavParentsNormalize(), NavParentsSet()
property SourceFile as %String (MAXLEN = 100);
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 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 TitleCount as %Integer [ InitialExpression = 1 ];
Property methods: TitleCountDisplayToLogical(), TitleCountGet(), TitleCountGetStored(), TitleCountIsValid(), TitleCountLogicalToDisplay(), TitleCountNormalize(), TitleCountSet()
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 UnitType as %String (MAXLEN = 200);
Type of child unit (chapter, appendix, etc.)
Property methods: UnitTypeDisplayToLogical(), UnitTypeGet(), UnitTypeGetStored(), UnitTypeIsValid(), UnitTypeLogicalToDisplay(), UnitTypeLogicalToOdbc(), UnitTypeNormalize(), UnitTypeSet()
property WordCount as %Integer;
Property methods: WordCountDisplayToLogical(), WordCountGet(), WordCountGetStored(), WordCountIsValid(), WordCountLogicalToDisplay(), WordCountNormalize(), WordCountSet()
property WordCountNoSampleCode as %Integer;
Property methods: WordCountNoSampleCodeDisplayToLogical(), WordCountNoSampleCodeGet(), WordCountNoSampleCodeGetStored(), WordCountNoSampleCodeIsValid(), WordCountNoSampleCodeLogicalToDisplay(), WordCountNoSampleCodeNormalize(), WordCountNoSampleCodeSet()
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

classmethod CreateOrOpen(DocBookId="") as DBMTables.Pages
classmethod GenerateXMLReport(verbose As %Boolean = 0)
classmethod GetReadingMinutes(wordcount As %Integer) as %Integer
classmethod Rebuild(verbose As %Integer = 0, getCounts As %Boolean = 0)
verbose can be 0, 1, 2, or 3
classmethod UpdateWordCount(verbose As %Boolean = 1)

Indexes

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 (TitleIdx on Title);
Index methods: TitleIdxExists()
index (UnitTypeIdx on UnitType);
Index methods: UnitTypeIdxExists()
index (productIdx on product);
Index methods: productIdxExists()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (DBMTables.Pages)

^DBMTables.PagesD(ID)
=
%%CLASSNAME
SourceFile
DocBookId
Document
Title
TitleCount
TitleRaw
TitleNice
SubtitleNice
UnitType
product
Description
DescIsGenerated
DescLength
NavParents
NavParentCount
CharCount
WordCount
WordCountNoSampleCode
FeedbackOpens in a new tab