Skip to main content

HS.Registry.Document.Classification

persistent class HS.Registry.Document.Classification extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Registry_Document.Classification

Property Inventory

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

Properties

property Attributes as array of %String (MAXLEN = 32000, STORAGEDEFAULT = "array", XMLNAME = "Attributes", XMLPROJECTION = "ELEMENT");
Property methods: AttributesBuildValueArray(), AttributesCollectionToDisplay(), AttributesCollectionToOdbc(), AttributesDisplayToCollection(), AttributesDisplayToLogical(), AttributesGet(), AttributesGetObject(), AttributesGetObjectId(), AttributesGetStored(), AttributesGetSwizzled(), AttributesIsValid(), AttributesLogicalToDisplay(), AttributesLogicalToOdbc(), AttributesNormalize(), AttributesOdbcToCollection(), AttributesSet(), AttributesSetObject(), AttributesSetObjectId()
property ClassificationNode as %String);
Property methods: ClassificationNodeDisplayToLogical(), ClassificationNodeGet(), ClassificationNodeGetStored(), ClassificationNodeIsValid(), ClassificationNodeLogicalToDisplay(), ClassificationNodeLogicalToOdbc(), ClassificationNodeNormalize(), ClassificationNodeSet()
property ClassificationScheme as %String);
Property methods: ClassificationSchemeDisplayToLogical(), ClassificationSchemeGet(), ClassificationSchemeGetStored(), ClassificationSchemeIsValid(), ClassificationSchemeLogicalToDisplay(), ClassificationSchemeLogicalToOdbc(), ClassificationSchemeNormalize(), ClassificationSchemeSet()
property ClassifiedObject as %String (MAXLEN = 256, SELECTIVITY = ".0000269%") [ Calculated ];
Property methods: ClassifiedObjectCompute(), ClassifiedObjectDisplayToLogical(), ClassifiedObjectGet(), ClassifiedObjectIsValid(), ClassifiedObjectLogicalToDisplay(), ClassifiedObjectLogicalToOdbc(), ClassifiedObjectNormalize(), ClassifiedObjectSQLCompute()
property Comments as HS.Registry.Document.Type.ValueType (SELECTIVITY = "99%", XMLNAME = "Comments", XMLPROJECTION = "ELEMENT");
Property methods: CommentsGet(), CommentsGetObject(), CommentsGetObjectId(), CommentsGetStored(), CommentsGetSwizzled(), CommentsIsEmpty(), CommentsIsValid(), CommentsNewObject(), CommentsSet(), CommentsSetObject(), CommentsSetObjectId(), CommentsUnSwizzle()
property Description as list of HS.Registry.Document.Type.ValueType (SELECTIVITY = "99%", XMLNAME = "Description", XMLPROJECTION = "ELEMENT");
Property methods: DescriptionBuildValueArray(), DescriptionCollectionToDisplay(), DescriptionCollectionToOdbc(), DescriptionDisplayToCollection(), DescriptionGet(), DescriptionGetObject(), DescriptionGetObjectId(), DescriptionGetStored(), DescriptionGetSwizzled(), DescriptionIsValid(), DescriptionOdbcToCollection(), DescriptionSet(), DescriptionSetObject(), DescriptionSetObjectId()
relationship Document as HS.Registry.Document (SELECTIVITY = ".0052%", XMLPROJECTION = "NONE") [ Inverse = Classifications , Cardinality = one ];
Property methods: DocumentCheck(), DocumentDelete(), DocumentGet(), DocumentGetObject(), DocumentGetObjectId(), DocumentGetStored(), DocumentGetSwizzled(), DocumentIDsForScheme(), DocumentIndexExists(), DocumentIsValid(), DocumentNewObject(), DocumentOnDelete(), DocumentRClose(), DocumentRExec(), DocumentRFetch(), DocumentRelate(), DocumentSQLCompute(), DocumentSQLFKeyExists(), DocumentSQLFKeyRefAction(), DocumentSet(), DocumentSetObject(), DocumentSetObjectId(), DocumentUnRelate(), DocumentUnSwizzle(), DocumentsForScheme()
property IID as %String (MAXLEN = 256, SELECTIVITY = 1, XMLNAME = "id", XMLPROJECTION = "ATTRIBUTE");
Property methods: IIDDisplayToLogical(), IIDGet(), IIDGetStored(), IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint(), IIDIsValid(), IIDLogicalToDisplay(), IIDLogicalToOdbc(), IIDNormalize(), IIDSet()
property Name as list of HS.Registry.Document.Type.ValueType (SELECTIVITY = "7%", XMLNAME = "Name", XMLPROJECTION = "ELEMENT");
Property methods: NameBuildValueArray(), NameCollectionToDisplay(), NameCollectionToOdbc(), NameDisplayToCollection(), NameGet(), NameGetObject(), NameGetObjectId(), NameGetStored(), NameGetSwizzled(), NameIsValid(), NameOdbcToCollection(), NameSet(), NameSetObject(), NameSetObjectId()
property NodeRepresentation as %String);
Property methods: NodeRepresentationDisplayToLogical(), NodeRepresentationGet(), NodeRepresentationGetStored(), NodeRepresentationIndexExists(), NodeRepresentationIsValid(), NodeRepresentationLogicalToDisplay(), NodeRepresentationLogicalToOdbc(), NodeRepresentationNormalize(), NodeRepresentationSet()
relationship RegistryPackage as HS.Registry.Document.RegistryPackage (SELECTIVITY = ".022%", XMLPROJECTION = "NONE") [ Inverse = Classifications , Cardinality = one ];
Property methods: RegistryPackageCheck(), RegistryPackageDelete(), RegistryPackageGet(), RegistryPackageGetObject(), RegistryPackageGetObjectId(), RegistryPackageGetStored(), RegistryPackageGetSwizzled(), RegistryPackageIndexExists(), RegistryPackageIsValid(), RegistryPackageNewObject(), RegistryPackageOnDelete(), RegistryPackageRClose(), RegistryPackageRExec(), RegistryPackageRFetch(), RegistryPackageRelate(), RegistryPackageSQLCompute(), RegistryPackageSQLFKeyExists(), RegistryPackageSQLFKeyRefAction(), RegistryPackageSet(), RegistryPackageSetObject(), RegistryPackageSetObjectId(), RegistryPackageUnRelate(), RegistryPackageUnSwizzle()
property Scheme as %String);
Property methods: SchemeDisplayToLogical(), SchemeGet(), SchemeGetStored(), SchemeIsValid(), SchemeLogicalToDisplay(), SchemeLogicalToOdbc(), SchemeNormalize(), SchemeSet()
relationship Slots as array of HS.Registry.Document.Slot (SELECTIVITY = ".04%", XMLNAME = "Slot", XMLPROJECTION = "ELEMENT") [ InitialExpression = $listbuild("HS.Registry.Document.Slot","Classification",+$this,"many",1,1) , Transient , Inverse = Classification , Cardinality = many ];
Property methods: SlotsGet(), SlotsGetObject(), SlotsGetObjectId(), SlotsGetSwizzled(), SlotsIsEmpty(), SlotsIsValid(), SlotsNewObject(), SlotsRClose(), SlotsRExec(), SlotsRFetch(), SlotsRelate(), SlotsSQLCompute(), SlotsSet(), SlotsUnRelate()
property Title as HS.Registry.Document.Type.ValueType (SELECTIVITY = "7%", XMLNAME = "Title", XMLPROJECTION = "ELEMENT");
Property methods: TitleGet(), TitleGetObject(), TitleGetObjectId(), TitleGetStored(), TitleGetSwizzled(), TitleIsEmpty(), TitleIsValid(), TitleNewObject(), TitleSet(), TitleSetObject(), TitleSetObjectId(), TitleUnSwizzle()

Methods

classmethod %OnDelete(oid As %ObjectIdentity) as %Status
This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted. [Previously private]

classmethod DocumentIDsForScheme(pScheme As %String, pValue As %String, %pDocuments As %String, pOutputSet As HS.Types.IHE.Errors, pSchemeText="") as %Status
classmethod DocumentsForScheme(pScheme As %String, pValue As %String, ByRef pDocuments As %String, pOutputSet As HS.Types.IHE.Errors) as %Status
find ClassifiedObject references for scheme
method Validate(pOutputSet) as %Boolean

Indexes

index ($Classification on ) [Extent, Type = bitmap];
index (AttributesIndex on Attributes(ELEMENTS),Attributes(KEYS));
index (DocumentIndex on Document);
Index methods: DocumentIndexExists()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (IIDIndex on IID) [Unique];
Index methods: IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint()
index (NodeIndex on ClassificationNode) [Type = bitmap];
index (NodeRepresentationIndex on NodeRepresentation);
Index methods: NodeRepresentationIndexExists()
index (RegistryPackageIndex on RegistryPackage);
Index methods: RegistryPackageIndexExists()
index (SchemeIndex on ClassificationScheme) [Type = bitmap];

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (HS.Registry.Document.Classification)

^HS.Registry.DocClassificationD(ID,"Attributes",n)
=
Attributes(n)

Storage Model: Storage (HS.Registry.Document.Classification)

^HS.Registry.DocClassificationD(ID)
=
%%CLASSNAME
IID
Name
Description
NodeRepresentation
ClassificationScheme
ClassificationNode
Scheme
RegistryPackage
Document
ClassifiedObject
Title

Storage Model: Storage (HS.Registry.Document.Classification)

^HS.Registry.DocClassificationD(ID,"Comments",n)
=
Comments(n)
FeedbackOpens in a new tab