DocumentSet ClassDocumentSet ClassDocumentSet Class

Inheritance Hierarchy

• Namespace: XmlPrimeXmlPrimeXmlPrime
• Assembly: XmlPrime (in XmlPrime.dll)

Constructors

	Constructor	Description
	DocumentSet ()DocumentSet ()DocumentSet ()	Initializes a new instance of the DocumentSetDocumentSetDocumentSet class, with no access to external documents and using a ConcurrentNameTableConcurrentNameTableConcurrentNameTable.
	DocumentSet (XmlNameTable)DocumentSet (XmlNameTable)DocumentSet (XmlNameTable^)	Initializes a new instance of the DocumentSetDocumentSetDocumentSet class, with no access to external documents.
	DocumentSet (XmlNameTable, IDocumentResolver, ICollectionResolver, IResourceResolver)DocumentSet (XmlNameTable, IDocumentResolver, ICollectionResolver, IResourceResolver)DocumentSet (XmlNameTable^, IDocumentResolver^, ICollectionResolver^, IResourceResolver^)	Initializes a new instance of the DocumentSetDocumentSetDocumentSet class.
	DocumentSet (XmlNameTable, InputSettings)DocumentSet (XmlNameTable, InputSettings)DocumentSet (XmlNameTable^, InputSettings^)	Initializes a new instance of the DocumentSetDocumentSetDocumentSet class.
	DocumentSet (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.
	DocumentSet (XmlNameTable, InputSettings, IDocumentResolver, ICollectionResolver, IResourceResolver, bool)DocumentSet (XmlNameTable, InputSettings, IDocumentResolver, ICollectionResolver, IResourceResolver, Boolean)DocumentSet (XmlNameTable^, InputSettings^, IDocumentResolver^, ICollectionResolver^, IResourceResolver^, bool)	Initializes a new instance of the DocumentSetDocumentSetDocumentSet class.
	DocumentSet (XmlResolver, XmlReaderSettings)DocumentSet (XmlResolver, XmlReaderSettings)DocumentSet (XmlResolver^, XmlReaderSettings^)	Initializes a new thread-safe instance of the DocumentSetDocumentSetDocumentSet class with the specified XmlResolverXmlResolverXmlResolver and XmlReaderSettingsXmlReaderSettingsXmlReaderSettings instance.
	DocumentSet (XmlResolver, XmlReaderSettings, bool)DocumentSet (XmlResolver, XmlReaderSettings, Boolean)DocumentSet (XmlResolver^, XmlReaderSettings^, bool)	Initializes a new instance of the DocumentSetDocumentSetDocumentSet class with the specified XmlResolverXmlResolverXmlResolver and XmlReaderSettingsXmlReaderSettingsXmlReaderSettings instance.
	DocumentSet (InputSettings, XmlResolver, XmlReaderSettings, bool)DocumentSet (InputSettings, XmlResolver, XmlReaderSettings, Boolean)DocumentSet (InputSettings^, XmlResolver^, XmlReaderSettings^, bool)	Initializes a new instance of the DocumentSetDocumentSetDocumentSet class with the specified XmlResolverXmlResolverXmlResolver and XmlReaderSettingsXmlReaderSettingsXmlReaderSettings instance.

Top

Properties

	Property	Description
	CollectionTypeResolverCollectionTypeResolverCollectionTypeResolver	Gets a document type resolver returning the actual types of collection in the document set.
	DocumentTypeResolverDocumentTypeResolverDocumentTypeResolver	Gets a document type resolver returning the actual types of documents in the document set.
	NameTableNameTableNameTable	Gets the name table used by the documents in this DocumentSetDocumentSetDocumentSet.

Top

Methods

	Method	Description
	AddCollection (AnyUri, IEnumerable<XPathItem>)AddCollection (AnyUri, IEnumerable(Of XPathItem))AddCollection (AnyUri^, IEnumerable<XPathItem^>^)	Associates the specified items with the specified collection URI, or marks the collection URI as unavailable.
	AddCollection (AnyUri, IXPathNavigable[])AddCollection (AnyUri, IXPathNavigable())AddCollection (AnyUri^, array<IXPathNavigable^>^)	Associates the specified nodes with the specified collection URI, or marks the collection URI as unavailable.
	AddDocument (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.
	AddDocument (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.
	AddDocument (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.
	AddResourceAddResourceAddResource	Adds the resource represented by the specified StreamStreamStream to the set of available resources, and associates it with its document URI.
	CollectionCollectionCollection	Returns an IXPathNavigableIXPathNavigableIXPathNavigable instance representing the collection retrieved from the specified URI.
	CreateResultDocumentHandlerCreateResultDocumentHandlerCreateResultDocumentHandler	Creates a new result document handler for the current document set.
	CreateXmlResolverCreateXmlResolverCreateXmlResolver	Creates a new XmlResolverXmlResolverXmlResolver instance which retrieves resources from this document set.
	DocumentDocumentDocument	Returns an XPathNavigatorXPathNavigatorXPathNavigator instance representing a node in the document retrieved from the specified URI.
	Object.EqualsObject.EqualsObject::Equals	Determines whether the specified object is equal to the current object.(Inherited from System.ObjectSystem.ObjectSystem::Object)
	Object.FinalizeObject.FinalizeObject::Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from System.ObjectSystem.ObjectSystem::Object)
	Object.GetHashCodeObject.GetHashCodeObject::GetHashCode	Serves as the default hash function. (Inherited from System.ObjectSystem.ObjectSystem::Object)
	Object.GetTypeObject.GetTypeObject::GetType	Gets the TypeTypeType of the current instance.(Inherited from System.ObjectSystem.ObjectSystem::Object)
	IncludeWellKnownDocumentTypeDefinitionsIncludeWellKnownDocumentTypeDefinitionsIncludeWellKnownDocumentTypeDefinitions	Adds a collection of well known DTDs to the document set.
	Object.MemberwiseCloneObject.MemberwiseCloneObject::MemberwiseClone	Creates a shallow copy of the current objectObjectobject.(Inherited from System.ObjectSystem.ObjectSystem::Object)
	ProcessInputSettingsProcessInputSettingsProcessInputSettings	Returns a DocumentSetDocumentSetDocumentSet which applies the specified InputSettingsInputSettingsInputSettings to the current DocumentSetDocumentSetDocumentSet.
	ReplaceDocumentReplaceDocumentReplaceDocument	Replaces the document.
	ResolvedDocumentResolvedDocumentResolvedDocument	Returns an ResolvedDocumentResolvedDocumentResolvedDocument instance representing the document retrieved from the specified URI.
	ResourceResourceResource	Returns the resource with the specified URI.
	ShareDocumentSet ()ShareDocumentSet ()ShareDocumentSet ()	Returns a new SharedDocumentSetSharedDocumentSetSharedDocumentSet which wraps the current document set..
	ShareDocumentSet (XmlNameTable)ShareDocumentSet (XmlNameTable)ShareDocumentSet (XmlNameTable^)	Returns a new SharedDocumentSetSharedDocumentSetSharedDocumentSet which wraps the current document set and uses the specified XmlNameTableXmlNameTableXmlNameTable.
	Object.ToStringObject.ToStringObject::ToString	Returns a string that represents the current object.(Inherited from System.ObjectSystem.ObjectSystem::Object)
	TryGetCollectionTryGetCollectionTryGetCollection	Gets the collection with the specified URI from the DocumentSetDocumentSetDocumentSet.
	TryGetDocumentTryGetDocumentTryGetDocument	Gets the document with the specified URI from the DocumentSetDocumentSetDocumentSet.
	TryGetResourceTryGetResourceTryGetResource	Gets the resource with the specified URI from the DocumentSetDocumentSetDocumentSet.
	TryGetUnparsedTextTryGetUnparsedTextTryGetUnparsedText	Gets the unparsed text of the resource with the specified URI from the DocumentSetDocumentSetDocumentSet.
	UnparsedTextUnparsedTextUnparsedText	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.

See Also