/// <summary>
/// Remove IshField entries that by preferring ishvaluetype id over element over value
/// </summary>
private IshFields RemoveDuplicateFields(IshFields ishFields)
{
if (ishFields == null || (ishFields.Count() == 0))
{
return(new IshFields());
}
// Initialize using the Id fields
IshFields returnIshFields = new IshFields(ishFields.Fields().Where(f => f.ValueType == Enumerations.ValueType.Id).ToArray());
// Add the fields having ishvaluetype Element, if not already specified as Id
foreach (var ishField in ishFields.Fields().Where(f => f.ValueType == Enumerations.ValueType.Element))
{
if (!returnIshFields.Fields().Any(f => f.Name == ishField.Name && f.Level == ishField.Level))
{
returnIshFields.AddField(ishField);
}
}
// Add the fields having ishvaluetype Value, if not already specified as Id or Element
foreach (var ishField in ishFields.Fields().Where(f => f.ValueType == Enumerations.ValueType.Value))
{
if (!returnIshFields.Fields().Any(f => f.Name == ishField.Name && f.Level == ishField.Level))
{
returnIshFields.AddField(ishField);
}
}
return(returnIshFields);
}
/// <summary>
/// Generates a new ishfields object where all fields only have requested field information (e.g. no Value, but ValueType if available)
/// </summary>
/// <returns>The current list of <see cref="IshFields"/>.</returns>
public IshFields ToRequestedFields()
{
IshFields returnFields = new IshFields();
foreach (IshField ishField in _fields)
{
returnFields.AddField(ishField.ToRequestedMetadataField());
}
return(returnFields);
}
/// <summary>
/// Generates exact filters (using Equal operator) from the given fields
/// </summary>
/// <returns>The current list of <see cref="IshFields"/>.</returns>
public IshFields ToFilterFields()
{
IshFields returnFields = new IshFields();
foreach (IshField ishField in _fields)
{
returnFields.AddField(ishField.ToMetadataFilterField());
}
return(returnFields);
}
/// <summary>
/// Generates a new ishfields object where all fields only have requested field information (e.g. no Value, but ValueType if available)
/// Remove all level entries that do not match the filter.
/// </summary>
/// <param name="filterFieldLevel">Level attribute that should be matched to be part of the result.</param>
/// <returns>The current list of <see cref="IshFields"/>.</returns>
public IshFields ToRequestedFields(Enumerations.Level filterFieldLevel)
{
IshFields returnFields = new IshFields();
foreach (IshField ishField in _fields)
{
if (ishField.Level.Equals(filterFieldLevel))
{
returnFields.AddField(ishField.ToRequestedMetadataField());
}
}
return(returnFields);
}
/// <summary>
/// Reverse lookup for all fields that are marked descriptive for the incoming ishTypes; then add them to ishFields.
/// </summary>
private IshFields AddDescriptiveFields(Enumerations.ISHType[] ishTypes, IshFields ishFields, Enumerations.ActionMode actionMode)
{
foreach (Enumerations.ISHType ishType in ishTypes)
{
foreach (var ishTypeFieldDefinition in _ishTypeFieldDefinitions.Values.Where(d => d.ISHType == ishType && d.IsDescriptive == true))
{
//TODO [Could] IshTypeFieldSetup adding descriptive fields potentially has an issue with removing to many ValueType entries
ishFields.AddOrUpdateField(new IshRequestedMetadataField(ishTypeFieldDefinition.Name, ishTypeFieldDefinition.Level, Enumerations.ValueType.Value), Enumerations.ActionMode.Read);
if (ishTypeFieldDefinition.DataType == Enumerations.DataType.ISHLov || ishTypeFieldDefinition.DataType == Enumerations.DataType.ISHType)
{
ishFields.AddOrUpdateField(new IshRequestedMetadataField(ishTypeFieldDefinition.Name, ishTypeFieldDefinition.Level, Enumerations.ValueType.Element), Enumerations.ActionMode.Read);
}
}
}
return(ishFields);
}
/// <summary>
/// Merge or Join the incoming ishfields (IshMetadataFields) on my own ishfields using the provided action
/// </summary>
/// <param name="ishFields">Fields to join with my own fields</param>
/// <param name="valueAction">String action (overwrite/prepend/append) to use on matching fields</param>
public virtual void JoinFields(IshFields ishFields, Enumerations.ValueAction valueAction)
{
foreach (IshField actionIshField in ishFields.Fields())
{
IshField[] overwriteFields = Retrieve(actionIshField.Name, actionIshField.Level);
if (overwriteFields.Length > 0)
{
// field is present, overwrite occurances
foreach (IshField ourIshField in overwriteFields)
{
ourIshField.Join(actionIshField, valueAction);
}
}
else
{
// field was not yet present, add it
AddField(actionIshField);
}
}
}
/// <summary>
/// Correctly named overload of ToIshMetadataFields(...). Allows tuning in the future.
/// </summary>
public IshFields ToIshRequiredCurrentMetadataFields(Enumerations.ISHType[] ishTypes, IshFields ishFields, Enumerations.ActionMode actionMode)
{
return(ToIshMetadataFields(ishTypes, ishFields, actionMode));
}
/// <summary>
/// Metadata write operations will be duplicated and cleared client side.
/// Unallowed fields for write operations (IshFieldDefinition.AllowOnCreate/AllowOnUpdate) will be stripped with a Debug log message.
/// </summary>
/// <remarks>Logs debug entry for unknown combinations of ishTypes, ishField (name, level), mandatory, multi-value,... entries - will not throw.</remarks>
/// <param name="ishTypes">Given ISHTypes (like ISHMasterDoc, ISHLibrary, ISHConfiguration,...) to verify/alter the IshFields for</param>
/// <param name="ishFields">Incoming IshFields entries will be transformed to matching and allowed IshMetadataField entries</param>
/// <param name="actionMode">MetadataFields only has value for write operations like Create, Update,...</param>
public IshFields ToIshMetadataFields(Enumerations.ISHType[] ishTypes, IshFields ishFields, Enumerations.ActionMode actionMode)
{
IshFields metadataFields = new IshFields();
foreach (Enumerations.ISHType ishType in ishTypes)
{
foreach (IshField ishField in ishFields.Fields())
{
var key = Enumerations.Key(ishType, ishField.Level, ishField.Name);
// Any unknown field will be skipped, unless strict is Off
if (!_ishTypeFieldDefinitions.ContainsKey(key))
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.SilentlyContinue:
_logger.WriteDebug($"ToIshMetadataFields skipping unknown ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}] valueType[{ishField.ValueType}]");
break;
case Enumerations.StrictMetadataPreference.Continue:
_logger.WriteVerbose($"ToIshMetadataFields skipping unknown ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}] valueType[{ishField.ValueType}]");
break;
case Enumerations.StrictMetadataPreference.Off:
metadataFields.AddOrUpdateField(ishField.ToMetadataField(), actionMode);
break;
}
continue; // move to next ishField
}
// Known field, however could be not allowed for current action
switch (actionMode)
{
case Enumerations.ActionMode.Create:
if (!_ishTypeFieldDefinitions[key].AllowOnCreate)
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.Continue:
_logger.WriteVerbose($"ToIshMetadataFields AllowOnCreate removed ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}] valueType[{ishField.ValueType}]");
break;
}
}
else
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.SilentlyContinue:
case Enumerations.StrictMetadataPreference.Continue:
// Doing an Add, as a later RemoveDuplicateFields can be smarter to keep the 'best' metadata field
metadataFields.AddField(ishField.ToMetadataField());
break;
case Enumerations.StrictMetadataPreference.Off:
// Doing an AddOrUpdate (Replace), so only one ValueType is left to avoid ambiguity on a Create/Update API call
metadataFields.AddOrUpdateField(ishField.ToMetadataField(), actionMode);
break;
}
}
break;
case Enumerations.ActionMode.Update:
if (!_ishTypeFieldDefinitions[key].AllowOnUpdate)
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.Continue:
_logger.WriteVerbose($"ToIshMetadataFields AllowOnUpdate removed ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}]");
break;
}
}
else
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.SilentlyContinue:
case Enumerations.StrictMetadataPreference.Continue:
// Doing an Add, as a later RemoveDuplicateFields can be smarter to keep the 'best' metadata field
metadataFields.AddField(ishField.ToMetadataField());
break;
case Enumerations.StrictMetadataPreference.Off:
// Doing an AddOrUpdate (Replace), so only one ValueType is left to avoid ambiguity on a Create/Update API call
metadataFields.AddOrUpdateField(ishField.ToMetadataField(), actionMode);
break;
}
//TODO [Should] IshTypeFieldSetup - Potential conflict if ishField having multiple ishvaluetype have conflicting entries for id/element/value
// 1. For IshBaseline the name field is a controlled field, so FISHDOCUMENTRELEASE linked to DDOCUMENTRELEASE.
// Specifying the label FISHDOCUMENTRELEASE overrules the element name, because you are renaming
// 2. For IshDocumentObj the author field is a controlled field, so FAUTHOR linked to USER
// Specifying the label "Admin" is less accurate than the element name "VUSERADMIN"
// Two cases to illustrate that is not easy to fix. Workaround is to do Set-* cmdlets by -Id and -Metadata instead of -IshObject holding the new values
// ==> For now solved by passing ActionMode to IshFields.AddOrUpdateField where for Create/Update all ValueTypes are removed, last one wins
}
break;
default:
_logger.WriteDebug($"ToIshMetadataFields called for actionMode[{actionMode}], skipping");
break;
}
}
}
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.SilentlyContinue:
_logger.WriteDebug($"Removing duplicate IshField entries");
metadataFields = RemoveDuplicateFields(metadataFields);
break;
case Enumerations.StrictMetadataPreference.Continue:
_logger.WriteVerbose($"Removing duplicate IshField entries");
metadataFields = RemoveDuplicateFields(metadataFields);
break;
case Enumerations.StrictMetadataPreference.Off:
// not removing duplicate entries potentially causing errors like: [-105007] The field "FISHUSERLANGUAGE" can only be specified once on level "None". [105007;FieldAlreadySpecified]
break;
}
return(metadataFields);
}
/// <summary>
/// Requested metadata fields will be duplicated and enriched to cater our Public Objects initilization.
/// The minimal fields (IsDescriptive) will be added to allow initialization of the various IshObject types for all ValueTypes.
/// Unallowed fields for read operations (IshFieldDefinition.AllowOnRead) will be stripped with a Debug log message.
/// </summary>
/// <remarks>Logs debug entry for unknown combinations of ishTypes and ishField (name, level) entries - will not throw.</remarks>
/// <param name="ishTypes">Given ISHTypes (like ISHMasterDoc, ISHLibrary, ISHConfiguration,...) to verify/alter the IshFields for</param>
/// <param name="ishFields">Incoming IshFields entries will be transformed to matching and allowed IshRequestedMetadataField entries</param>
/// <param name="actionMode">RequestedMetadataFields only has value for read operations like Read, Find, Search,...</param>
public IshFields ToIshRequestedMetadataFields(Enumerations.ISHType[] ishTypes, IshFields ishFields, Enumerations.ActionMode actionMode)
{
IshFields requestedMetadataFields = new IshFields();
foreach (Enumerations.ISHType ishType in ishTypes)
{
// Check incoming IshField with IshTypeFieldDefinitions
foreach (IshField ishField in ishFields.Fields())
{
var key = Enumerations.Key(ishType, ishField.Level, ishField.Name);
if (!_ishTypeFieldDefinitions.ContainsKey(key))
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.SilentlyContinue:
_logger.WriteDebug($"ToIshRequestedMetadataFields skipping unknown ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}] valueType[{ishField.ValueType}]");
break;
case Enumerations.StrictMetadataPreference.Continue:
_logger.WriteVerbose($"ToIshRequestedMetadataFields skipping unknown ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}] valueType[{ishField.ValueType}]");
break;
case Enumerations.StrictMetadataPreference.Off:
requestedMetadataFields.AddField(ishField.ToRequestedMetadataField());
break;
}
continue; // move to next ishField
}
switch (actionMode)
{
case Enumerations.ActionMode.Read:
case Enumerations.ActionMode.Find:
if (!_ishTypeFieldDefinitions[key].AllowOnRead)
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.Continue:
_logger.WriteVerbose($"ToIshRequestedMetadataFields AllowOnRead removed ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}] valueType[{ishField.ValueType}]");
break;
case Enumerations.StrictMetadataPreference.Off:
requestedMetadataFields.AddField(ishField.ToRequestedMetadataField());
break;
}
}
else
{
requestedMetadataFields.AddOrUpdateField(ishField.ToRequestedMetadataField(), actionMode);
}
break;
case Enumerations.ActionMode.Search:
if (!_ishTypeFieldDefinitions[key].AllowOnSearch)
{
switch (_strictMetadataPreference)
{
case Enumerations.StrictMetadataPreference.Continue:
_logger.WriteVerbose($"ToIshRequestedMetadataFields AllowOnSearch removed ishType[{ishType}] level[{ishField.Level}] name[{ishField.Name}] valueType[{ishField.ValueType}]");
break;
case Enumerations.StrictMetadataPreference.Off:
requestedMetadataFields.AddField(ishField.ToRequestedMetadataField());
break;
}
}
else
{
requestedMetadataFields.AddOrUpdateField(ishField.ToRequestedMetadataField(), actionMode);
}
break;
default:
_logger.WriteDebug($"ToIshRequestedMetadataFields called for actionMode[{actionMode}], skipping");
break;
}
}
}
//Add IsDescriptive fields for the incoming IshType to allow basic descriptive/minimal object initialization
requestedMetadataFields = AddDescriptiveFields(ishTypes, requestedMetadataFields, actionMode);
//TODO [Should] Merges in IsDescriptive for all ValueTypes (for LOV/Card)... we cannot do IMetadataBinding fields yet. Server-side they are retrieved anyway, so the only penalty is xml transfer size.
return(requestedMetadataFields);
}
