DocumentSet ClassDocumentSet ClassDocumentSet Class

Contains a stable cache of documents and collections used in an XQuery program, XPath expression or XSL transformation.

Inheritance Hierarchy

Syntax

Public Class DocumentSet
public class DocumentSet
public:
ref class DocumentSet
 
The DocumentSetDocumentSetDocumentSet type exposes the following members.

Constructors

 ConstructorDescription
Public methodDocumentSet (XmlNameTable)DocumentSet (XmlNameTable)DocumentSet (XmlNameTable^) Initializes a new instance of the DocumentSetDocumentSetDocumentSet class, with no access to external documents.
Public methodDocumentSet (XmlNameTable, IDocumentResolver, ICollectionResolver, IResourceResolver)DocumentSet (XmlNameTable, IDocumentResolver, ICollectionResolver, IResourceResolver)DocumentSet (XmlNameTable^, IDocumentResolver^, ICollectionResolver^, IResourceResolver^) Initializes a new instance of the DocumentSetDocumentSetDocumentSet class.
Public methodDocumentSet (XmlNameTable, InputSettings)DocumentSet (XmlNameTable, InputSettings)DocumentSet (XmlNameTable^, InputSettings^) Initializes a new instance of the DocumentSetDocumentSetDocumentSet class.
Public methodDocumentSet (XmlNameTable, InputSettings, IDocumentResolver, ICollectionResolver, IResourceResolver)DocumentSet (XmlNameTable, InputSettings, IDocumentResolver, ICollectionResolver, IResourceResolver)DocumentSet (XmlNameTable^, InputSettings^, IDocumentResolver^, ICollectionResolver^, IResourceResolver^) Initializes a new instance of the DocumentSetDocumentSetDocumentSet class.
Public methodDocumentSet (XmlResolver, XmlReaderSettings)DocumentSet (XmlResolver, XmlReaderSettings)DocumentSet (XmlResolver^, XmlReaderSettings^) Initializes a new instance of the DocumentSetDocumentSetDocumentSet class with the specified XmlResolverXmlResolverXmlResolver and XmlReaderSettingsXmlReaderSettingsXmlReaderSettings instance.
Public methodDocumentSet (InputSettings, XmlResolver, XmlReaderSettings)DocumentSet (InputSettings, XmlResolver, XmlReaderSettings)DocumentSet (InputSettings^, XmlResolver^, XmlReaderSettings^) Initializes a new instance of the DocumentSetDocumentSetDocumentSet class with the specified XmlResolverXmlResolverXmlResolver and XmlReaderSettingsXmlReaderSettingsXmlReaderSettings instance.

Top

Properties

 PropertyDescription
Public propertyCollectionTypeResolverCollectionTypeResolverCollectionTypeResolver Gets a document type resolver returning the actual types of collection in the document set.
Public propertyDocumentTypeResolverDocumentTypeResolverDocumentTypeResolver Gets a document type resolver returning the actual types of documents in the document set.
Public propertyNameTableNameTableNameTable Gets the name table used by the documents in this DocumentSetDocumentSetDocumentSet.

Top

Methods

 MethodDescription
Public methodAddCollectionAddCollectionAddCollection Associates the specified nodes with the specified collection URI, or marks the collection URI as unavailable.
Public methodAddDocument (IXPathNavigable)AddDocument (IXPathNavigable)AddDocument (IXPathNavigable^) Adds the document represented by the specified IXPathNavigableIXPathNavigableIXPathNavigable to the set of available documents, and associates it with its document URI.
Public methodAddDocument (AnyUri, IXPathNavigable)AddDocument (AnyUri, IXPathNavigable)AddDocument (AnyUri^, IXPathNavigable^) Adds the document represented by the specified IXPathNavigableIXPathNavigableIXPathNavigable to the set of available documents, and associates it with the specified document URI, or marks a document as unavailable.
Public methodAddDocument (AnyUri, ResolvedDocument)AddDocument (AnyUri, ResolvedDocument)AddDocument (AnyUri^, ResolvedDocument^) Adds the document represented by the specified ResolvedDocumentResolvedDocumentResolvedDocument to the set of available documents, and associates it with the specified document URI, or marks a document as unavailable.
Public methodAddResourceAddResourceAddResource Adds the resource represented by the specified StreamStreamStream to the set of available resources, and associates it with its document URI.
Public methodCollectionCollectionCollection Returns an IXPathNavigableIXPathNavigableIXPathNavigable instance representing the collection retrieved from the specified URI.
Public methodCreateXmlResolverCreateXmlResolverCreateXmlResolver Creates a new XmlResolverXmlResolverXmlResolver instance which retrieves resources from this document set.
Public methodDocumentDocumentDocument Returns an XPathNavigatorXPathNavigatorXPathNavigator instance representing a node in the document retrieved from the specified URI.
Public methodObject.EqualsObject.EqualsObject::Equals Determines whether the specified objectObjectobject is equal to the current objectObjectobject. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Protected methodObject.FinalizeObject.FinalizeObject::Finalize Allows an objectObjectobject to attempt to free resources and perform other cleanup operations before the objectObjectobject is reclaimed by garbage collection. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodObject.GetHashCodeObject.GetHashCodeObject::GetHashCode Serves as a hash function for a particular type. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodObject.GetTypeObject.GetTypeObject::GetType Gets the TypeTypeType of the current instance. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodIncludeWellKnownDTDsIncludeWellKnownDTDsIncludeWellKnownDTDs Adds a collection of well known DTDs to the document set.
Protected methodObject.MemberwiseCloneObject.MemberwiseCloneObject::MemberwiseClone Creates a shallow copy of the current objectObjectobject. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodResolvedDocumentResolvedDocumentResolvedDocument Returns an ResolvedDocumentResolvedDocumentResolvedDocument instance representing the document retrieved from the specified URI.
Public methodResourceResourceResource Returns the resource with the specified URI.
Public methodObject.ToStringObject.ToStringObject::ToString Returns a stringStringString that represents the current objectObjectobject. (Inherited from System.ObjectSystem.ObjectSystem::Object)
Public methodTryGetCollectionTryGetCollectionTryGetCollection Gets the collection with the specified URI from the DocumentSetDocumentSetDocumentSet.
Public methodTryGetDocumentTryGetDocumentTryGetDocument Gets the document with the specified URI from the DocumentSetDocumentSetDocumentSet.
Public methodTryGetResourceTryGetResourceTryGetResource Gets the resource with the specified URI from the DocumentSetDocumentSetDocumentSet.
Public methodTryGetUnparsedTextTryGetUnparsedTextTryGetUnparsedText Gets the unparsed text of the resource with the specified URI from the DocumentSetDocumentSetDocumentSet.
Public methodUnparsedTextUnparsedTextUnparsedText Returns a stringStringString containing the unparsed text of a resource with the specified URI.

Top

Remarks

The document set keeps a cache of all documents and collections available to the query, and those marked as unavailable. Whenever a document or collection is retrieved it is added to the DocumentSetDocumentSetDocumentSet. Should,an error occur retrieving a document or collection, the URI is marked as unavailable in the document set. This helps to enforce the stability of the fn:doc, fn:doc-available, fn:collection, fn:document, fn:unparsed-text and fn:unparsed-text-available functions, and the constraint that doc(document-uri($N)) is $N is true for any document node $N.

This defines the available documents, available collections and default collection components of the dynamic context.

The DocumentSetDocumentSetDocumentSet property specifies the DocumentSetDocumentSetDocumentSet to be used when evaluating an XQuery program, XSL transformation or XPath expression.

All methods of DocumentSetDocumentSetDocumentSet are thread safe can be called concurrently from multiple threads.