Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

DBMTables.LinksInternal

persistent class DBMTables.LinksInternal extends %Library.Persistent

SQL Table Name: DBMTables.LinksInternal

Property Inventory

Method Inventory

Properties

property ActualTitle as %String);
Property methods: ActualTitleDisplayToLogical(), ActualTitleGet(), ActualTitleGetStored(), ActualTitleIsValid(), ActualTitleLogicalToDisplay(), ActualTitleLogicalToOdbc(), ActualTitleNormalize(), ActualTitleSet()
property LinkOK as %Boolean;
Displayed in table; used as filter.
Property methods: LinkOKDisplayToLogical(), LinkOKGet(), LinkOKGetStored(), LinkOKIsValid(), LinkOKLogicalToDisplay(), LinkOKNormalize(), LinkOKSet()
property LinkTag as %String;
Allowed values: "link" "ulink" "olink" "n/a" Displayed in table; used as filter.
Property methods: LinkTagDisplayToLogical(), LinkTagGet(), LinkTagGetStored(), LinkTagIsValid(), LinkTagLogicalToDisplay(), LinkTagLogicalToOdbc(), LinkTagNormalize(), LinkTagSet()
property LinkTarget as %String);
Displayed in table; used as filter.
Property methods: LinkTargetDisplayToLogical(), LinkTargetGet(), LinkTargetGetStored(), LinkTargetIsValid(), LinkTargetLogicalToDisplay(), LinkTargetLogicalToOdbc(), LinkTargetNormalize(), LinkTargetSet()
property NearestHeading as %String (MAXLEN = 200);
Nearest heading (either ParentTopic or a heading above that
Property methods: NearestHeadingDisplayToLogical(), NearestHeadingGet(), NearestHeadingGetStored(), NearestHeadingIsValid(), NearestHeadingLogicalToDisplay(), NearestHeadingLogicalToOdbc(), NearestHeadingNormalize(), NearestHeadingSet()
property NearestHeadingId as %String (MAXLEN = 200);
DocBookId. of nearest heading (either ParentTopic or a heading above that)
Property methods: NearestHeadingIdDisplayToLogical(), NearestHeadingIdGet(), NearestHeadingIdGetStored(), NearestHeadingIdIsValid(), NearestHeadingIdLogicalToDisplay(), NearestHeadingIdLogicalToOdbc(), NearestHeadingIdNormalize(), NearestHeadingIdSet()
property ParentTopic as %String (MAXLEN = 200);
Parent DocBookId. Displayed in table; used as filter.
Property methods: ParentTopicDisplayToLogical(), ParentTopicGet(), ParentTopicGetStored(), ParentTopicIsValid(), ParentTopicLogicalToDisplay(), ParentTopicLogicalToOdbc(), ParentTopicNormalize(), ParentTopicSet()
property SamePage as %Boolean;
1 if the link is to another spot on the same page
Property methods: SamePageDisplayToLogical(), SamePageGet(), SamePageGetStored(), SamePageIsValid(), SamePageLogicalToDisplay(), SamePageNormalize(), SamePageSet()
property ShortContent as %String (MAXLEN = 50);
First 50 characters of the text that contains the link. Displayed in table.
Property methods: ShortContentDisplayToLogical(), ShortContentGet(), ShortContentGetStored(), ShortContentIsValid(), ShortContentLogicalToDisplay(), ShortContentLogicalToOdbc(), ShortContentNormalize(), ShortContentSet()
property SourceFile as %String (MAXLEN = 100);
This is the name of the file from which this content was taken. Displayed in table; used as filter.
Property methods: SourceFileDisplayToLogical(), SourceFileGet(), SourceFileGetStored(), SourceFileIsValid(), SourceFileLogicalToDisplay(), SourceFileLogicalToOdbc(), SourceFileNormalize(), SourceFileSet()
property SourceTopid as %String (MAXLEN = 200);
TOPID of record that contains the link
Property methods: SourceTopidDisplayToLogical(), SourceTopidGet(), SourceTopidGetStored(), SourceTopidIsValid(), SourceTopidLogicalToDisplay(), SourceTopidLogicalToOdbc(), SourceTopidNormalize(), SourceTopidSet()
property TargetType as %String;
Type of child unit (chapter, sect1, etc.)
Property methods: TargetTypeDisplayToLogical(), TargetTypeGet(), TargetTypeGetStored(), TargetTypeIsValid(), TargetTypeLogicalToDisplay(), TargetTypeLogicalToOdbc(), TargetTypeNormalize(), TargetTypeSet()
Property methods: TitleInLinkDisplayToLogical(), TitleInLinkGet(), TitleInLinkGetStored(), TitleInLinkIsValid(), TitleInLinkLogicalToDisplay(), TitleInLinkLogicalToOdbc(), TitleInLinkNormalize(), TitleInLinkSet()
property TitlesMatch as %Boolean;
Property methods: TitlesMatchDisplayToLogical(), TitlesMatchGet(), TitlesMatchGetStored(), TitlesMatchIsValid(), TitlesMatchLogicalToDisplay(), TitlesMatchNormalize(), TitlesMatchSet()
property TitlesMatchIfIgnoreCase as %Boolean;
Property methods: TitlesMatchIfIgnoreCaseDisplayToLogical(), TitlesMatchIfIgnoreCaseGet(), TitlesMatchIfIgnoreCaseGetStored(), TitlesMatchIfIgnoreCaseIsValid(), TitlesMatchIfIgnoreCaseLogicalToDisplay(), TitlesMatchIfIgnoreCaseNormalize(), TitlesMatchIfIgnoreCaseSet()

Methods

classmethod GenerateXMLReport(verbose As %Boolean = 0)
classmethod Rebuild(verbose As %Integer = 0) as %Integer
iterate through all the blocks and find the blocks that have internal links. verbose can be 0, 1, or 2

Indexes

index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (LinkOKIdx on LinkOK);
Index methods: LinkOKIdxExists()
index (LinkTagIdx on LinkTag);
Index methods: LinkTagIdxExists()
index (NearestHeadingIdx on NearestHeading);
Index methods: NearestHeadingIdxExists()
index (ParentTopicIdx on ParentTopic);
Index methods: ParentTopicIdxExists()
index (SourceFileIdx on SourceFile);
Index methods: SourceFileIdxExists()
index (SourceTopidIdx on SourceTopid);
Index methods: SourceTopidIdxExists()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (DBMTables.LinksInternal)

^DBMTables.LinksInternalD(ID)
 =
%%CLASSNAME
SourceFile
ParentTopic
ActualTitle
TitleInLink
ShortContent
Match
TitlesMatch
new
LinkOK
LinkTag
NearestHeadingId
NearestHeading
LinkTarget
TitlesMatchIfIgnoreCase
SourceTopid
TargetType
SamePage
FeedbackOpens in a new tab