Class StreamingFragmentReader

Streams IVersionable items from a DDI XML fragment file.

Inheritance

object

StreamingFragmentReader

Implements

IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Algenta.Colectica.Model.Ddi.Serialization

Assembly: Algenta.Colectica.Model.Ddi.dll

Syntax

public class StreamingFragmentReader : IDisposable

Constructors

StreamingFragmentReader(string)

Initializes a new instance of the StreamingFragmentReader class.

Declaration

public StreamingFragmentReader(string inputUri)

Parameters

Type	Name	Description
string	inputUri	The filename or URL of the DDI XML to be processed.

Exceptions

Type	Condition
InvalidOperationException	Unknown XML DDI Fragment file.

Properties

FormatDetected

Gets the format of the DDI XML fragment file.

Declaration

public DdiFileFormat FormatDetected { get; }

Property Value

Type	Description
DdiFileFormat

TopLevelReferences

Gets a list of top level items found in the fragment file.

Declaration

public ReadOnlyCollection<IdentifierTriple> TopLevelReferences { get; }

Property Value

Type	Description
ReadOnlyCollection<IdentifierTriple>

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

GetItemStream()

Gets an enumerations of IVersionable items found in the DDI XML fragment file.

Declaration

public IEnumerable<IVersionable> GetItemStream()

Returns

Type	Description
IEnumerable<IVersionable>

GetItemStream(bool)

Gets an enumerations of IVersionable items found in the DDI XML fragment file.

Declaration

public IEnumerable<IVersionable> GetItemStream(bool useItemCache)

Parameters

Type	Name	Description
bool	useItemCache	Populate previously found child items using the item cache

Returns

Type	Description
IEnumerable<IVersionable>

Remarks

Child objects will be cached and populated when encountered.

Implements

IDisposable