Publish.DocBook
persistent class Publish.DocBook extends %Library.Persistent, %XML.Adaptor
SQL Table Name: Publish.DocBook
Persistent class used to store data read from relinfo files.Property Inventory
Parameters
parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected
elements in the XML input.
The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default).
By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error.
If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling
of empty strings for properties of type %String. By default (XMLIGNORENULL = 0),
empty strings in the XML input are stored as $c(0) and $c(0) is written to XML
as an empty tag. A missing tag in the XML input is always stored as "" and
"" is always output to XML as no tag.
If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).
If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.
If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).
If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.
If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
Properties
property ExclusionList as %String);
List of DocBookIDs (one per line) that we do not want to load for this version of the doc.
Can be books or articles -- not case-sensitive.
Property methods: ExclusionListDisplayToLogical(), ExclusionListGet(), ExclusionListGetStored(), ExclusionListIsValid(), ExclusionListLogicalToDisplay(), ExclusionListLogicalToOdbc(), ExclusionListNormalize(), ExclusionListSet()
property HelpTargetsDir as %String);
If specified, this is the directory where we can find the help targets files.
Property methods: HelpTargetsDirDisplayToLogical(), HelpTargetsDirGet(), HelpTargetsDirGetStored(), HelpTargetsDirIsValid(), HelpTargetsDirLogicalToDisplay(), HelpTargetsDirLogicalToOdbc(), HelpTargetsDirNormalize(), HelpTargetsDirSet()
property HideThese as %String);
List of DocBookIDs (one per line) that we do not want to be available via search.
Can be books or articles -- not case-sensitive.
Property methods: HideTheseDisplayToLogical(), HideTheseGet(), HideTheseGetStored(), HideTheseIsValid(), HideTheseLogicalToDisplay(), HideTheseLogicalToOdbc(), HideTheseNormalize(), HideTheseSet()
property MasterDir as %String);
If specified, this is the directory where we can find the macros file.
Property methods: MasterDirDisplayToLogical(), MasterDirGet(), MasterDirGetStored(), MasterDirIsValid(), MasterDirLogicalToDisplay(), MasterDirLogicalToOdbc(), MasterDirNormalize(), MasterDirSet()
relationship Release as Publish.RelInfo [ Required , Inverse = DocBookDetails , Cardinality = parent ];
Property methods: ReleaseGet(), ReleaseGetObject(), ReleaseGetObjectId(), ReleaseGetStored(), ReleaseGetSwizzled(), ReleaseIsValid(), ReleaseNewObject(), ReleaseOnDelete(), ReleaseRClose(), ReleaseRExec(), ReleaseRFetch(), ReleaseRelate(), ReleaseSQLCompute(), ReleaseSet(), ReleaseSetObject(), ReleaseSetObjectId(), ReleaseUnRelate(), ReleaseUnSwizzle()
property SourceDirs as list of %String);
Property methods: SourceDirsBuildValueArray(), SourceDirsCollectionToDisplay(), SourceDirsCollectionToOdbc(), SourceDirsDisplayToCollection(), SourceDirsDisplayToLogical(), SourceDirsGet(), SourceDirsGetObject(), SourceDirsGetObjectId(), SourceDirsGetStored(), SourceDirsGetSwizzled(), SourceDirsIsValid(), SourceDirsLogicalToDisplay(), SourceDirsLogicalToOdbc(), SourceDirsNormalize(), SourceDirsOdbcToCollection(), SourceDirsSet(), SourceDirsSetObject(), SourceDirsSetObjectId()
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
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()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: CacheStorage (Publish.DocBook)
{%%PARENT}("DocBookDetails")(ID) | = | %%CLASSNAME
SourceDirs
MasterDir
ExclusionList
HideThese
HelpTargetsDir
|