/// <summary>
/// Retrieves all available dataflows.
/// </summary>
private IComplexStructureQuery RetrieveDataflows()
{
var dataflowRefBean = new StructureReferenceImpl(SdmxStructureType.GetFromEnum(SdmxStructureEnumType.Dataflow));
IRestStructureQuery structureQueryDataflow = new RESTStructureQueryCore(dataflowRefBean);
IBuilder <IComplexStructureQuery, IRestStructureQuery> transformerDataFlow = new StructureQuery2ComplexQueryBuilder();
IComplexStructureQuery complexStructureQueryDataflow = transformerDataFlow.Build(structureQueryDataflow);
IList <SdmxStructureType> specificObjects = new List <SdmxStructureType>();
specificObjects.Add(SdmxStructureType.GetFromEnum(SdmxStructureEnumType.Dsd));
IComplexStructureQueryMetadata complexStructureQueryMetadataWithDsd =
new ComplexStructureQueryMetadataCore(false,
ComplexStructureQueryDetail.GetFromEnum(ComplexStructureQueryDetailEnumType.Full),
ComplexMaintainableQueryDetail.GetFromEnum(ComplexMaintainableQueryDetailEnumType.Full),
StructureReferenceDetail.GetFromEnum(StructureReferenceDetailEnumType.Specific),
specificObjects);
IComplexStructureQuery complexStructureQueryTempDataflow = new ComplexStructureQueryCore(
complexStructureQueryDataflow.StructureReference, complexStructureQueryMetadataWithDsd);
return(complexStructureQueryTempDataflow);
}
/// <summary>
/// Sends the specified <paramref name="complexStructureQuery"/> to the Web Service defined by <see cref="_config"/>
/// </summary>
/// <param name="complexStructureQuery">The <see cref="IComplexStructureQuery"/></param>
/// <returns>The ISdmxObjects returned by the Web Service</returns>
private ISdmxObjects SendQueryStructureRequest(IComplexStructureQuery complexStructureQuery, SDMXWSFunctionV21 sdmxwsFunctionV21)
{
IStructureQueryFormat <XDocument> queryFormat = new ComplexQueryFormatV21();
IComplexStructureQueryFactory <XDocument> factory = new ComplexStructureQueryFactoryV21 <XDocument>();
IComplexStructureQueryBuilderManager <XDocument> complexStructureQueryBuilderManager = new ComplexStructureQueryBuilderManager <XDocument>(factory);
var wdoc = complexStructureQueryBuilderManager.BuildComplexStructureQuery(complexStructureQuery, queryFormat);
var doc = new XmlDocument();
doc.LoadXml(wdoc.ToString());
string tempFileName = Path.GetTempFileName();
try
{
this.SendRequest(doc, sdmxwsFunctionV21, tempFileName);
ISdmxObjects structureObjects = new SdmxObjectsImpl();
IStructureParsingManager parsingManager = new StructureParsingManager(SdmxSchemaEnumType.Null);
using (var dataLocation = new FileReadableDataLocation(tempFileName))
{
IStructureWorkspace structureWorkspace = parsingManager.ParseStructures(dataLocation);
structureObjects = structureWorkspace.GetStructureObjects(false);
}
NsiClientValidation.CheckResponse(structureObjects);
return(structureObjects);
}
finally
{
//Delete the temporary file
File.Delete(tempFileName);
}
}
/// <summary>
/// Retrieves all available categorisations and category schemes.
/// </summary>
private IComplexStructureQuery RetrieveCategorySchemesAndCategorisations()
{
var catSch = new StructureReferenceImpl(SdmxStructureType.GetFromEnum(SdmxStructureEnumType.CategoryScheme));
IRestStructureQuery structureQueryCategoryScheme = new RESTStructureQueryCore(StructureQueryDetail.GetFromEnum(StructureQueryDetailEnumType.Full), StructureReferenceDetail.GetFromEnum(StructureReferenceDetailEnumType.Parents), null, catSch, false);
IBuilder <IComplexStructureQuery, IRestStructureQuery> transformerCategoryScheme = new StructureQuery2ComplexQueryBuilder();
IComplexStructureQuery complexStructureQueryCategoryScheme = transformerCategoryScheme.Build(structureQueryCategoryScheme);
return(complexStructureQueryCategoryScheme);
}
/// <summary>
/// Gets the maintainables.
/// </summary>
/// <param name="structureQuery">The structure query.</param>
/// <param name="allowedDataflows">The allowed dataflows.</param>
/// <returns>The <see cref="IMutableObjects"/>.</returns>
public IMutableObjects GetMaintainables(IComplexStructureQuery structureQuery, IList<IMaintainableRefObject> allowedDataflows)
{
var mutableObjects = this._mutableStructureSearchManager.GetMaintainables(structureQuery);
if (allowedDataflows != null)
{
return new MutableObjectsImpl(mutableObjects.AllMaintainables.Where(o => allowedDataflows.Any(refObject => refObject.IsMatch(o))));
}
return mutableObjects;
}
/// <summary>
/// Retrieve the structures referenced by <paramref name="structureQuery" /> and populate the
/// <paramref name="mutableObjects" />
/// </summary>
/// <param name="retrievalManager">The retrieval manager.</param>
/// <param name="mutableObjects">The mutable objects.</param>
/// <param name="structureQuery">The structure query.</param>
/// <param name="allowedDataflows">The allowed Dataflows.</param>
/// <param name="crossReferenceMutableRetrievalManager">The cross reference mutable retrieval manager.</param>
protected virtual void PopulateMutables(
IAuthAdvancedSdmxMutableObjectRetrievalManager retrievalManager,
IMutableObjects mutableObjects,
IComplexStructureQuery structureQuery,
IList<IMaintainableRefObject> allowedDataflows,
IAuthCrossReferenceMutableRetrievalManager crossReferenceMutableRetrievalManager)
{
//// changes here might also apply to AuthMutableStructureSearchManagerBase and/or AuthStructureRetrieverV21
var complexStructureQueryDetail = structureQuery.StructureQueryMetadata != null ? structureQuery.StructureQueryMetadata.StructureQueryDetail : ComplexStructureQueryDetail.GetFromEnum(ComplexStructureQueryDetailEnumType.Full);
mutableObjects.AddIdentifiables(retrievalManager.GetMutableMaintainables(structureQuery.StructureReference, complexStructureQueryDetail, allowedDataflows));
}
/// <summary>
/// Gets a bean with data about the key family for specified dataflow.
/// </summary>
/// <param name="dataflow">
/// The dataflow
/// </param>
/// <returns>
/// a <c>StructureBean</c> instance with requested data; the result is never <c>null</c> or incomplete, instead an exception is throwed away if something goes wrong and not all required data is successfully retrieved
/// </returns>
/// <remarks>
/// The resulted bean will contain exactly one key family, but also will include any concepts and codelists referenced by the key family.
/// </remarks>
public ISdmxObjects GetStructure(IDataflowObject dataflow, ISet <IDataStructureObject> dataStructures)
{
Logger.InfoFormat(
CultureInfo.InvariantCulture,
Resources.InfoGettingStructureFormat3,
dataflow.AgencyId,
dataflow.Id,
dataflow.Version);
ISdmxObjects structure = new SdmxObjectsImpl();
try
{
ISdmxObjects responseConceptScheme = new SdmxObjectsImpl();
ISdmxObjects response = new SdmxObjectsImpl();
IDataStructureObject dsd = NsiClientHelper.GetDsdFromDataflow(dataflow, dataStructures);
structure.AddDataStructure(dsd);
NsiClientValidation.CheckifStructureComplete(structure, dataflow);
IEnumerable <IStructureReference> conceptRefs = NsiClientHelper.BuildConceptSchemeRequest(structure.DataStructures.First());
foreach (var structureReference in conceptRefs)
{
IRestStructureQuery structureQueryConceptScheme = new RESTStructureQueryCore(structureReference);
IBuilder <IComplexStructureQuery, IRestStructureQuery> transformerCategoryScheme = new StructureQuery2ComplexQueryBuilder();
IComplexStructureQuery complexStructureQueryConceptScheme = transformerCategoryScheme.Build(structureQueryConceptScheme);
responseConceptScheme = this.SendQueryStructureRequest(complexStructureQueryConceptScheme, SDMXWSFunctionV21.GetConceptScheme);
response.Merge(responseConceptScheme);
}
structure.Merge(response);
NsiClientValidation.CheckConcepts(structure);
Logger.Info(Resources.InfoSuccess);
}
catch (NsiClientException e)
{
Logger.Error(Resources.ExceptionGettingStructure);
Logger.Error(e.Message, e);
throw;
}
catch (Exception e)
{
Logger.Error(Resources.ExceptionGettingStructure);
Logger.Error(e.Message, e);
throw new NsiClientException(Resources.ExceptionGettingStructure, e);
}
return(structure);
}
/// <summary>
/// Gets the maintainables.
/// </summary>
/// <param name="structureQuery">The structure query.</param>
/// <returns>The <see cref="IMutableObjects"/>.</returns>
public IMutableObjects GetMaintainables(IComplexStructureQuery structureQuery)
{
// In this sample we convert the SDMX v2.1 SOAP request to REST.
var maintainableRefObject = structureQuery.StructureReference.GetMaintainableRefObject();
var structureReference = new StructureReferenceImpl(maintainableRefObject, structureQuery.StructureReference.ReferencedStructureType);
StructureQueryDetail structureQueryDetail = Convert(structureQuery.StructureQueryMetadata.StructureQueryDetail, structureQuery.StructureQueryMetadata.ReferencesQueryDetail);
StructureReferenceDetail reference = structureQuery.StructureQueryMetadata.StructureReferenceDetail;
SdmxStructureType specificStructureReference = null;
if (structureQuery.StructureQueryMetadata.ReferenceSpecificStructures != null)
{
specificStructureReference = structureQuery.StructureQueryMetadata.ReferenceSpecificStructures.FirstOrDefault();
}
bool returnLatest = structureQuery.StructureReference.VersionReference.IsReturnLatest.IsTrue;
IRestStructureQuery restStructureQuery = new RESTStructureQueryCore(structureQueryDetail, reference, specificStructureReference, structureReference, returnLatest);
return this._mutableStructureSearchManager.GetMaintainables(restStructureQuery);
}
/// <summary>
/// The get maintainables.
/// </summary>
/// <param name="structureQuery">
/// The structure query.
/// </param>
/// <returns>
/// The <see cref="IMutableObjects"/>.
/// </returns>
public IMutableObjects GetMaintainables(IComplexStructureQuery structureQuery)
{
return this._authAdvancedMutableStructureSearchManager.GetMaintainables(structureQuery, null);
}
/// <summary>
/// Retrieves all available categorisations.
/// </summary>
/// <returns>
/// a list of &lt;c&gt;ISdmxObjects&lt;/c&gt; instances; the result won&apos;t be &lt;c&gt;null&lt;/c&gt; if there are no
/// dataflows, instead an empty list will be returned
/// </returns>
public ISdmxObjects RetrieveCategorisations()
{
Logger.Info(Resources.InfoGettingCategorySchemes);
//Get category schemes and categorisations
ISdmxObjects responseCategorySchemes = new SdmxObjectsImpl();
IComplexStructureQuery complexStructureQueryCategoryScheme = RetrieveCategorySchemesAndCategorisations();
//Get dataflows
ISdmxObjects responseDataflows = new SdmxObjectsImpl();
IComplexStructureQuery complexStructureQueryDataflow = RetrieveDataflows();
try
{
try
{
responseCategorySchemes = this.SendQueryStructureRequest(complexStructureQueryCategoryScheme, SDMXWSFunctionV21.GetCategoryScheme);
}
catch (DataflowException ex)
{
//do nothing
}
responseDataflows = this.SendQueryStructureRequest(complexStructureQueryDataflow, SDMXWSFunctionV21.GetDataflow);
//Remove from structure (ISdmxObjects) the DSDS built with SDMX v2.0
var structureSdmxV20DSD = responseDataflows.DataStructures.Where(o => o.Annotations.Any(a => a.FromAnnotation() == CustomAnnotationType.SDMXv20Only)).ToArray();
foreach (var sdmxV20Only in structureSdmxV20DSD)
{
responseDataflows.RemoveDataStructure(sdmxV20Only);
}
// DSDS with annotation
var sdmxV20onlyReferences = structureSdmxV20DSD.Select(o => o.AsReference).ToArray();
// Add the DSDS built with Sdmx V2.0
ISdmxObjects responseDSD = new SdmxObjectsImpl();
if (sdmxV20onlyReferences.Length > 0)
{
responseDSD = _nsiClientWs.SendQueryStructureRequest(sdmxV20onlyReferences, false);
responseDataflows.Merge(responseDSD);
}
responseCategorySchemes.Merge(responseDataflows);
if (responseCategorySchemes.CategorySchemes != null && responseCategorySchemes.Dataflows != null)
{
Logger.Info(Resources.InfoSuccess);
}
}
catch (NsiClientException e)
{
Logger.Error(Resources.ExceptionGettingDataflow);
Logger.Error(e.Message, e);
throw;
}
catch (DataflowException e)
{
throw;
}
catch (Exception e)
{
Logger.Error(Resources.ExceptionGettingDataflow);
Logger.Error(e.Message, e);
throw new NsiClientException(Resources.ExceptionGettingDataflow, e);
}
return(responseCategorySchemes);
}
/// <summary>
/// Initializes a new instance of the <see cref="QueryWorkspace"/> class.
/// </summary>
/// <param name="complexStructureQuery">
/// The complex structure reference.
/// </param>
public QueryWorkspace(IComplexStructureQuery complexStructureQuery)
{
this._complexStructureQuery = complexStructureQuery;
}
/// <summary>
/// Sends the specified <paramref name="complexStructureQuery"/> to the Web Service defined by <see cref="_config"/>
/// </summary>
/// <param name="complexStructureQuery">The <see cref="IComplexStructureQuery"/></param>
/// <returns>The ISdmxObjects returned by the Web Service</returns>
private ISdmxObjects SendQueryStructureRequest(IComplexStructureQuery complexStructureQuery, SDMXWSFunctionV21 sdmxwsFunctionV21)
{
IStructureQueryFormat<XDocument> queryFormat = new ComplexQueryFormatV21();
IComplexStructureQueryFactory<XDocument> factory = new ComplexStructureQueryFactoryV21<XDocument>();
IComplexStructureQueryBuilderManager<XDocument> complexStructureQueryBuilderManager = new ComplexStructureQueryBuilderManager<XDocument>(factory);
var wdoc = complexStructureQueryBuilderManager.BuildComplexStructureQuery(complexStructureQuery, queryFormat);
var doc = new XmlDocument();
doc.LoadXml(wdoc.ToString());
string tempFileName = Path.GetTempFileName();
try
{
this.SendRequest(doc, sdmxwsFunctionV21, tempFileName);
ISdmxObjects structureObjects = new SdmxObjectsImpl();
IStructureParsingManager parsingManager = new StructureParsingManager(SdmxSchemaEnumType.Null);
using (var dataLocation = new FileReadableDataLocation(tempFileName))
{
IStructureWorkspace structureWorkspace = parsingManager.ParseStructures(dataLocation);
structureObjects = structureWorkspace.GetStructureObjects(false);
}
NsiClientValidation.CheckResponse(structureObjects);
return structureObjects;
}
finally
{
//Delete the temporary file
File.Delete(tempFileName);
}
}
public ISdmxObjects GetStructure(string DataflowId, string DatafloAgency, string DatafloVersion, bool resolseRef = false)
{
Logger.InfoFormat(
CultureInfo.InvariantCulture,
Resources.InfoGettingStructureFormat3,
DatafloAgency,
DataflowId,
DatafloVersion);
ISdmxObjects structure = new SdmxObjectsImpl();
#region GetDataflow
//Get dataflows
ISdmxObjects responseDataflows = new SdmxObjectsImpl();
IComplexStructureQuery complexStructureQueryDataflow = RetrieveDataflow(DataflowId, DatafloAgency, DatafloVersion);
responseDataflows = this.SendQueryStructureRequest(complexStructureQueryDataflow, SDMXWSFunctionV21.GetDataflow);
//Remove from structure (ISdmxObjects) the DSDS built with SDMX v2.0
var structureSdmxV20DSD = responseDataflows.DataStructures.Where(o => o.Annotations.Any(a => a.FromAnnotation() == CustomAnnotationType.SDMXv20Only)).ToArray();
foreach (var sdmxV20Only in structureSdmxV20DSD)
{
responseDataflows.RemoveDataStructure(sdmxV20Only);
}
// DSDS with annotation
var sdmxV20onlyReferences = structureSdmxV20DSD.Select(o => o.AsReference).ToArray();
// Add the DSDS built with Sdmx V2.0
ISdmxObjects responseDSD = new SdmxObjectsImpl();
if (sdmxV20onlyReferences.Length > 0)
{
responseDSD = _nsiClientWs.SendQueryStructureRequest(sdmxV20onlyReferences, false);
responseDataflows.Merge(responseDSD);
}
if (responseDataflows.Dataflows == null || responseDataflows.Dataflows.Count == 0)
{
throw new Exception("Dataflow not found");
}
#endregion
try
{
IDataflowObject dataflow = responseDataflows.Dataflows.First();
ISdmxObjects responseConceptScheme = new SdmxObjectsImpl();
ISdmxObjects response = new SdmxObjectsImpl();
IDataStructureObject dsd = NsiClientHelper.GetDsdFromDataflow(dataflow, responseDataflows.DataStructures);
structure.AddDataStructure(dsd);
NsiClientValidation.CheckifStructureComplete(structure, dataflow);
IEnumerable <IStructureReference> conceptRefs = NsiClientHelper.BuildConceptSchemeRequest(structure.DataStructures.First());
foreach (var structureReference in conceptRefs)
{
IRestStructureQuery structureQueryConceptScheme = new RESTStructureQueryCore(structureReference);
IBuilder <IComplexStructureQuery, IRestStructureQuery> transformerCategoryScheme = new StructureQuery2ComplexQueryBuilder();
IComplexStructureQuery complexStructureQueryConceptScheme = transformerCategoryScheme.Build(structureQueryConceptScheme);
responseConceptScheme = this.SendQueryStructureRequest(complexStructureQueryConceptScheme, SDMXWSFunctionV21.GetConceptScheme);
response.Merge(responseConceptScheme);
}
structure.Merge(responseDataflows);
structure.Merge(response);
NsiClientValidation.CheckConcepts(structure);
Logger.Info(Resources.InfoSuccess);
}
catch (NsiClientException e)
{
Logger.Error(Resources.ExceptionGettingStructure);
Logger.Error(e.Message, e);
throw;
}
catch (Exception e)
{
Logger.Error(Resources.ExceptionGettingStructure);
Logger.Error(e.Message, e);
throw new NsiClientException(Resources.ExceptionGettingStructure, e);
}
return(structure);
}
/// <summary>
/// Get details specified in <paramref name="structureQuery"/> of the specified <paramref name="mutableObjects"/>
/// </summary>
/// <param name="structureQuery">
/// The structure query.
/// </param>
/// <param name="mutableObjects">
/// The mutable objects.
/// </param>
/// <param name="crossReferenceMutableRetrievalManager">
/// The cross Reference Mutable Retrieval Manager.
/// </param>
/// <param name="allowedDataflow">
/// The allowed Dataflow.
/// </param>
/// <exception cref="NotImplementedException">
/// Not implemented value at <see cref="StructureReferenceDetail"/> of <paramref name="structureQuery"/>
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// Invalid value at <see cref="StructureReferenceDetail"/> of <paramref name="structureQuery"/>
/// </exception>
private static void GetDetails(
IComplexStructureQuery structureQuery,
IMutableObjects mutableObjects,
IAuthCrossReferenceMutableRetrievalManager crossReferenceMutableRetrievalManager,
IList<IMaintainableRefObject> allowedDataflow)
{
_log.InfoFormat("Reference detail: {0}", structureQuery.StructureQueryMetadata.StructureReferenceDetail);
bool returnStub = structureQuery.StructureQueryMetadata.StructureQueryDetail.EnumType != ComplexStructureQueryDetailEnumType.Full;
StructureReferenceDetail referenceDetail = structureQuery.StructureQueryMetadata.StructureReferenceDetail ?? StructureReferenceDetail.GetFromEnum(StructureReferenceDetailEnumType.None);
var specificStructureTypes = structureQuery.StructureQueryMetadata.ReferenceSpecificStructures != null ? structureQuery.StructureQueryMetadata.ReferenceSpecificStructures.ToArray() : null;
var resolver = _resolverFactory.GetResolver(referenceDetail, crossReferenceMutableRetrievalManager, specificStructureTypes);
resolver.ResolveReferences(mutableObjects, returnStub, allowedDataflow);
}
/// <summary>
/// Process the specified <paramref name="structureQuery"/> returning an
/// <see cref="T:Org.Sdmxsource.Sdmx.Api.Model.Mutable.IMutableObjects"/> container which contains the Maintainable
/// Structure hat correspond to the <paramref name="structureQuery"/> query parameters.
/// </summary>
/// <param name="structureQuery">
/// The structure query.
/// </param>
/// <param name="allowedDataflows">
/// The allowed Dataflows.
/// </param>
/// <returns>
/// The <see cref="T:Org.Sdmxsource.Sdmx.Api.Model.Mutable.IMutableObjects"/>.
/// </returns>
public IMutableObjects GetMaintainables(IComplexStructureQuery structureQuery, IList<IMaintainableRefObject> allowedDataflows)
{
if (structureQuery == null)
{
throw new ArgumentNullException("structureQuery");
}
IMutableObjects mutableObjects = new MutableObjectsImpl();
var cachedRetrievalManager = this._retrievalFactory.GetRetrievalManager(this._retrievalManager);
var crossReferenceMutableRetrievalManager = this._crossReferenceManagerFactory.GetCrossRetrievalManager(this._database, cachedRetrievalManager);
this.PopulateMutables(cachedRetrievalManager, mutableObjects, structureQuery, allowedDataflows, crossReferenceMutableRetrievalManager);
GetDetails(structureQuery, mutableObjects, crossReferenceMutableRetrievalManager, allowedDataflows);
mutableObjects.DataStructures.NormalizeSdmxv20DataStructures();
if (mutableObjects.AllMaintainables.Count == 0)
{
throw new SdmxNoResultsException("No structures found for the specific query");
}
return mutableObjects;
}
