/// <summary>
/// Generate a list of artifact summary information from a resource input stream,
/// using the default <see cref="ConformanceHarvesters"/>.
/// <para>
/// If the target resource represents a <see cref="Bundle"/> instance, then the generator
/// returns a list of summaries for all resource entries contained in the bundle.
/// </para>
/// </summary>
/// <param name="navStream">An <see cref="INavigatorStream"/> instance.</param>
/// <param name="initProperties">
/// An optional summary properties initialization method, or <c>null</c>.
/// If specified, the generator will call this method for each generated summary,
/// allowing the caller to modify or enrich the set of generated summary properties.
/// </param>
/// <param name="harvesters">
/// A list of <see cref="ArtifactSummaryHarvester"/> delegates that the
/// generator calls to harvest summary information from each artifact.
/// If the harvester list equals <c>null</c> or empty, then the generator will
/// harvest only the common default summary properties.
/// </param>
/// <returns>A list of new <see cref="ArtifactSummary"/> instances.</returns>
/// <remarks>
/// The generator catches all runtime exceptions that occur during harvesting and returns
/// them as <see cref="ArtifactSummary"/> instances with <see cref="ArtifactSummary.IsFaulted"/>
/// equal to <c>true</c> and <see cref="ArtifactSummary.Error"/> returning the exception.
/// </remarks>
public static List <ArtifactSummary> Generate(
INavigatorStream navStream,
Action <ArtifactSummaryPropertyBag> initProperties,
params ArtifactSummaryHarvester[] harvesters)
{
var result = new List <ArtifactSummary>();
// Factory returns null for unknown file formats
if (navStream == null)
{
return(result);
}
try
{
// Run default or specified (custom) harvesters
if (harvesters == null || harvesters.Length == 0)
{
harvesters = ConformanceHarvesters;
}
while (navStream.MoveNext())
{
var current = navStream.Current;
if (current != null)
{
var properties = new ArtifactSummaryPropertyBag();
// Initialize default summary information
// Note: not exposed by IElementNavigator, cannot use harvester
properties.SetPosition(navStream.Position);
properties.SetTypeName(current.Type);
properties.SetResourceUri(navStream.Position);
// Allow caller to modify/enrich harvested properties
initProperties?.Invoke(properties);
// Generate the final (immutable) ArtifactSummary instance
var summary = generate(properties, current, harvesters);
result.Add(summary);
}
}
}
// TODO Catch specific exceptions
// catch (System.IO.FileNotFoundException)
// catch (UnauthorizedAccessException)
// catch (System.Security.SecurityException)
// catch (FormatException)
catch (Exception ex)
{
result.Add(ArtifactSummary.FromException(ex));
}
finally
{
navStream?.Dispose();
}
return(result);
}
/// <summary>
/// Generate a list of artifact summary information for a resource file on disk,
/// using the specified list of <see cref="ArtifactSummaryHarvester"/> instances.
/// <para>
/// If the target resource represents a <see cref="Bundle"/> instance, then the generator
/// returns a list of summaries for all resource entries contained in the bundle.
/// </para>
/// </summary>
/// <param name="filePath">The file path of the target artifact (or the containing Bundle).</param>
/// <param name="harvesters">
/// A list of <see cref="ArtifactSummaryHarvester"/> delegates that the
/// generator calls to harvest summary information from each artifact.
/// If the harvester list equals <c>null</c> or empty, then the generator will
/// harvest only the common default summary properties.
/// </param>
/// <returns>A list of new <see cref="ArtifactSummary"/> instances.</returns>
/// <remarks>
/// The generator catches all runtime exceptions that occur during harvesting and returns
/// them as <see cref="ArtifactSummary"/> instances with <see cref="ArtifactSummary.IsFaulted"/>
/// equal to <c>true</c> and <see cref="ArtifactSummary.Error"/> returning the exception.
/// </remarks>
public List <ArtifactSummary> Generate(
string filePath,
params ArtifactSummaryHarvester[] harvesters)
{
List <ArtifactSummary> result = null;
// Try to create navigator stream factory
// May fail if the specified input is invalid => return error summary
INavigatorStream navStream = null;
try
{
// Get some source file properties
var fi = new FileInfo(filePath);
// Local helper method to initialize origin-specific summary properties
// All resources from common origin share common property values
void InitializeSummaryFromOrigin(ArtifactSummaryPropertyBag properties)
{
properties.SetOrigin(filePath);
properties.SetFileSize(fi.Length);
// implicit conversion to DateTimeOffet. This is allowed, because LastWriteTimeUtc is of DateTimeKind.Utc
properties.SetLastModified(fi.LastWriteTimeUtc);
switch (fi.Extension)
{
case FhirFileFormats.XmlFileExtension:
properties.SetSerializationFormat(FhirSerializationFormats.Xml);
break;
case FhirFileFormats.JsonFileExtension:
properties.SetSerializationFormat(FhirSerializationFormats.Json);
break;
}
}
// Factory returns null for unknown file formats
navStream = DefaultNavigatorStreamFactory.Create(filePath);
result = Generate(navStream, InitializeSummaryFromOrigin, harvesters);
}
catch (Exception ex)
{
result = new List <ArtifactSummary>
{
ArtifactSummary.FromException(ex, filePath)
};
}
return(result);
}
/// <summary>
/// Generate a list of artifact summary information for a resource file on disk,
/// using the specified list of <see cref="ArtifactSummaryHarvester"/> instances.
/// <para>
/// If the target resource represents a <see cref="Bundle"/> instance, then the generator
/// returns a list of summaries for all resource entries contained in the bundle.
/// </para>
/// </summary>
/// <param name="origin">The file path of the target artifact (or the containing Bundle).</param>
/// <param name="harvesters">
/// A list of <see cref="ArtifactSummaryHarvester"/> delegates that the
/// generator calls to harvest summary information from each artifact.
/// If the harvester list equals <c>null</c> or empty, then the generator will
/// harvest only the common default summary properties.
/// </param>
/// <returns>A list of new <see cref="ArtifactSummary"/> instances.</returns>
/// <remarks>
/// The generator catches all runtime exceptions that occur during harvesting and returns
/// them as <see cref="ArtifactSummary"/> instances with <see cref="ArtifactSummary.IsFaulted"/>
/// equal to <c>true</c> and <see cref="ArtifactSummary.Error"/> returning the exception.
/// </remarks>
public static List <ArtifactSummary> Generate(
string origin,
params ArtifactSummaryHarvester[] harvesters)
{
List <ArtifactSummary> result = null;
// Try to create navigator stream factory
// May fail if the specified input is invalid => return error summary
INavigatorStream navStream = null;
try
{
navStream = DefaultNavigatorStreamFactory.Create(origin);
// Factory returns null for unknown file formats
if (navStream != null)
{
// Get some source file properties
var fi = new FileInfo(origin);
// Resources from same origin share a common serialization format
string format =
fi.Extension == FhirFileFormats.XmlFileExtension ? FhirSerializationFormats.Xml
: fi.Extension == FhirFileFormats.JsonFileExtension ? FhirSerializationFormats.Json
: null;
// Local helper method to initialize specific summary properties
void InitializeSummaryFromOrigin(ArtifactSummaryPropertyBag properties)
{
properties.SetOrigin(origin);
properties.SetFileSize(fi.Length);
properties.SetLastModified(fi.LastWriteTimeUtc);
properties.SetSerializationFormat(format);
}
result = Generate(navStream, InitializeSummaryFromOrigin, harvesters);
}
}
catch (Exception ex)
{
result = new List <ArtifactSummary>
{
ArtifactSummary.FromException(ex, origin)
};
}
return(result);
}
private static Resource LoadBySummary(ArtifactSummary summary)
{
if (summary == null)
{
return(null);
}
using (var memoryStream = new MemoryStream(Encoding.UTF8.GetBytes(summary.Origin)))
using (var navStream = new JsonNavigatorStream(memoryStream))
{
if (navStream.Seek(summary.Position))
{
if (navStream.Current != null)
{
// TODO: Cache this parsed resource, to prevent parsing again and again
var resource = navStream.Current.ToPoco <Resource>();
return(resource);
}
}
}
return(null);
}