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.LinksClass

persistent class DBMTables.LinksClass extends %Library.Persistent

SQL Table Name: DBMTables.LinksClass

Property Inventory

Method Inventory

Properties

property LinkOK as %Boolean;
Displayed in table; used as filter.
Property methods: LinkOKDisplayToLogical(), LinkOKGet(), LinkOKGetStored(), LinkOKIsValid(), LinkOKLogicalToDisplay(), LinkOKNormalize(), LinkOKSet()
property LinkTarget as %String);
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 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 methods: TitleInLinkDisplayToLogical(), TitleInLinkGet(), TitleInLinkGetStored(), TitleInLinkIsValid(), TitleInLinkLogicalToDisplay(), TitleInLinkLogicalToOdbc(), TitleInLinkNormalize(), TitleInLinkSet()

Methods

classmethod GetBadClassLinkCount() as %Integer
classmethod GetClassLinkCount() as %Integer
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 (NearestHeadingIdx on NearestHeading);
Index methods: NearestHeadingIdxExists()
index (ParentTopicIdx on ParentTopic);
Index methods: ParentTopicIdxExists()
index (SourceFileIdx on SourceFile);
Index methods: SourceFileIdxExists()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (DBMTables.LinksClass)

^DBMTables.LinksClassD(ID)
=
%%CLASSNAME
SourceFile
ParentTopic
ActualTitle
TitleInLink
ShortContent
LinkOK
LinkTag
OlinkNamespace
OlinkClass
OlinkMemberName
OlinkMemberType
LinkTarget
NearestHeadingId
NearestHeading
FeedbackOpens in a new tab