/// <summary>
/// Translate a TypeSegment
/// </summary>
/// <param name="segment">the segment to Translate</param>
/// <returns>Defined by the implementer</returns>
public override string Translate(TypeSegment segment)
{
Debug.Assert(segment != null, "segment != null");
IEdmType type = segment.EdmType;
IEdmCollectionType collectionType = type as IEdmCollectionType;
if (collectionType != null)
{
type = collectionType.ElementType.Definition;
}
return("/" + type.FullTypeName());
}
/// <summary>
/// Follow an ODataPath from to get the most derived type
/// </summary>
/// <param name="path">the path to follow</param>
/// <param name="startingType">the starting type before beginning to walk the path.</param>
/// <returns>the most derived type in the path.</returns>
public static IEdmType GetMostDerivedTypeFromPath(ODataPath path, IEdmType startingType)
{
IEdmType currentType = startingType;
foreach (ODataPathSegment currentSegment in path)
{
TypeSegment typeSegment = currentSegment as TypeSegment;
if (typeSegment != null && typeSegment.EdmType.IsOrInheritsFrom(currentType))
{
currentType = typeSegment.EdmType;
}
}
return(currentType);
}
/// <summary>
/// Follow an ODataPath from an Expand to get the Final Nav Prop
/// </summary>
/// <param name="path">the path to follow</param>
/// <returns>the navigation property at the end of that path.</returns>
/// <exception cref="ODataException">Throws if the last segment in the path is not a nav prop.</exception>
public static IEdmNavigationProperty GetNavigationPropertyFromExpandPath(ODataPath path)
{
NavigationPropertySegment navPropSegment = null;
foreach (ODataPathSegment currentSegment in path)
{
TypeSegment typeSegment = currentSegment as TypeSegment;
navPropSegment = currentSegment as NavigationPropertySegment;
if (typeSegment == null && navPropSegment == null)
{
throw new ODataException(Strings.ExpandItemBinder_TypeSegmentNotFollowedByPath);
}
}
if (navPropSegment == null)
{
throw new ODataException(Strings.ExpandItemBinder_TypeSegmentNotFollowedByPath);
}
else
{
return(navPropSegment.NavigationProperty);
}
}
/// <summary>
/// Process a <see cref="PathSegmentToken"/> following any type segments if necessary.
/// </summary>
/// <param name="tokenIn">the path token to process.</param>
private List <ODataPathSegment> ProcessSelectTokenPath(PathSegmentToken tokenIn)
{
Debug.Assert(tokenIn != null, "tokenIn != null");
List <ODataPathSegment> pathSoFar = new List <ODataPathSegment>();
IEdmStructuredType currentLevelType = this.edmType;
// first, walk through all type segments in a row, converting them from tokens into segments.
if (tokenIn.IsNamespaceOrContainerQualified() && !UriParserHelper.IsAnnotation(tokenIn.Identifier))
{
PathSegmentToken firstNonTypeToken;
pathSoFar.AddRange(SelectExpandPathBinder.FollowTypeSegments(tokenIn, this.Model, this.Settings.SelectExpandLimit, this.configuration.Resolver, ref currentLevelType, out firstNonTypeToken));
Debug.Assert(firstNonTypeToken != null, "Did not get last token.");
tokenIn = firstNonTypeToken as NonSystemToken;
if (tokenIn == null)
{
throw new ODataException(ODataErrorStrings.SelectExpandBinder_SystemTokenInSelect(firstNonTypeToken.Identifier));
}
}
// next, create a segment for the first non-type segment in the path.
ODataPathSegment lastSegment = SelectPathSegmentTokenBinder.ConvertNonTypeTokenToSegment(tokenIn, this.Model, currentLevelType, this.configuration.Resolver, this.state);
// next, create an ODataPath and add the segments to it.
if (lastSegment != null)
{
pathSoFar.Add(lastSegment);
// try create a complex type property path.
while (true)
{
// no need to go on if the current property is not of complex type or collection of complex type,
// unless the segment is a primitive type cast or a property on an open complex property.
currentLevelType = lastSegment.EdmType as IEdmStructuredType;
IEdmCollectionType collectionType = lastSegment.EdmType as IEdmCollectionType;
IEdmPrimitiveType primitiveType = lastSegment.EdmType as IEdmPrimitiveType;
DynamicPathSegment dynamicPath = lastSegment as DynamicPathSegment;
if ((currentLevelType == null || currentLevelType.TypeKind != EdmTypeKind.Complex) &&
(collectionType == null || collectionType.ElementType.TypeKind() != EdmTypeKind.Complex) &&
(primitiveType == null || primitiveType.TypeKind != EdmTypeKind.Primitive) &&
(dynamicPath == null || tokenIn.NextToken == null))
{
break;
}
NonSystemToken nextToken = tokenIn.NextToken as NonSystemToken;
if (nextToken == null)
{
break;
}
if (UriParserHelper.IsAnnotation(nextToken.Identifier))
{
lastSegment = SelectPathSegmentTokenBinder.ConvertNonTypeTokenToSegment(nextToken, this.Model,
currentLevelType, this.configuration.Resolver, null);
}
else if (primitiveType == null && dynamicPath == null)
{
// This means last segment a collection of complex type,
// current segment can only be type cast and cannot be property name.
if (currentLevelType == null)
{
currentLevelType = collectionType.ElementType.Definition as IEdmStructuredType;
}
// If there is no collection type in the path yet, will try to bind property for the next token
// first try bind the segment as property.
lastSegment = SelectPathSegmentTokenBinder.ConvertNonTypeTokenToSegment(nextToken, this.Model,
currentLevelType, this.configuration.Resolver, null);
}
else
{
// determine whether we are looking at a type cast or a dynamic path segment.
EdmPrimitiveTypeKind nextTypeKind = EdmCoreModel.Instance.GetPrimitiveTypeKind(nextToken.Identifier);
IEdmPrimitiveType castType = EdmCoreModel.Instance.GetPrimitiveType(nextTypeKind);
if (castType != null)
{
lastSegment = new TypeSegment(castType, castType, null);
}
else if (dynamicPath != null)
{
lastSegment = new DynamicPathSegment(nextToken.Identifier);
}
else
{
throw new ODataException(ODataErrorStrings.SelectBinder_MultiLevelPathInSelect);
}
}
// then try bind the segment as type cast.
if (lastSegment == null)
{
IEdmStructuredType typeFromNextToken =
UriEdmHelpers.FindTypeFromModel(this.Model, nextToken.Identifier, this.configuration.Resolver) as
IEdmStructuredType;
if (typeFromNextToken.IsOrInheritsFrom(currentLevelType))
{
lastSegment = new TypeSegment(typeFromNextToken, /*entitySet*/ null);
}
}
// type cast failed too.
if (lastSegment == null)
{
break;
}
// try move to and add next path segment.
tokenIn = nextToken;
pathSoFar.Add(lastSegment);
}
}
// non-navigation cases do not allow further segments in $select.
if (tokenIn.NextToken != null)
{
throw new ODataException(ODataErrorStrings.SelectBinder_MultiLevelPathInSelect);
}
// Later, we can consider to create a "DynamicOperationSegment" to handle this.
// But now, Let's throw exception.
if (lastSegment == null)
{
throw new ODataException(ODataErrorStrings.MetadataBinder_InvalidIdentifierInQueryOption(tokenIn.Identifier));
}
// navigation property is not allowed to append sub path in the selection.
NavigationPropertySegment navPropSegment = pathSoFar.LastOrDefault() as NavigationPropertySegment;
if (navPropSegment != null && tokenIn.NextToken != null)
{
throw new ODataException(ODataErrorStrings.SelectBinder_MultiLevelPathInSelect);
}
return(pathSoFar);
}
/// <summary>
/// Translate a TypeSegment
/// </summary>
/// <param name="segment">the segment to Translate</param>
/// <returns>Defined by the implementer</returns>
public override string Translate(TypeSegment segment)
{
Debug.Assert(segment != null, "segment != null");
return(segment.EdmType.FullTypeName());
}
/// <summary>
/// Handle a TypeSegment
/// </summary>
/// <param name="segment">the segment to Handle</param>
public virtual void Handle(TypeSegment segment)
{
throw new NotImplementedException();
}
/// <summary>
/// Handle a TypeSegment
/// </summary>
/// <param name="segment">the segment to Handle</param>
public override void Handle(TypeSegment segment)
{
CommonHandler(segment);
}
private void ProcessTokenAsPath(NonSystemToken tokenIn)
{
Debug.Assert(tokenIn != null, "tokenIn != null");
List <ODataPathSegment> pathSoFar = new List <ODataPathSegment>();
IEdmStructuredType currentLevelType = this.edmType;
// first, walk through all type segments in a row, converting them from tokens into segments.
if (tokenIn.IsNamespaceOrContainerQualified() && !UriParserHelper.IsAnnotation(tokenIn.Identifier))
{
PathSegmentToken firstNonTypeToken;
pathSoFar.AddRange(SelectExpandPathBinder.FollowTypeSegments(tokenIn, this.model, this.maxDepth, this.resolver, ref currentLevelType, out firstNonTypeToken));
Debug.Assert(firstNonTypeToken != null, "Did not get last token.");
tokenIn = firstNonTypeToken as NonSystemToken;
if (tokenIn == null)
{
throw new ODataException(ODataErrorStrings.SelectPropertyVisitor_SystemTokenInSelect(firstNonTypeToken.Identifier));
}
}
// next, create a segment for the first non-type segment in the path.
ODataPathSegment lastSegment = SelectPathSegmentTokenBinder.ConvertNonTypeTokenToSegment(tokenIn, this.model, currentLevelType, resolver, this.state);
// next, create an ODataPath and add the segments to it.
if (lastSegment != null)
{
pathSoFar.Add(lastSegment);
// try create a complex type property path.
while (true)
{
// no need to go on if the current property is not of complex type or collection of complex type,
// unless the segment is a primitive type cast or a property on an open complex property.
currentLevelType = lastSegment.EdmType as IEdmStructuredType;
IEdmCollectionType collectionType = lastSegment.EdmType as IEdmCollectionType;
IEdmPrimitiveType primitiveType = lastSegment.EdmType as IEdmPrimitiveType;
DynamicPathSegment dynamicPath = lastSegment as DynamicPathSegment;
if ((currentLevelType == null || currentLevelType.TypeKind != EdmTypeKind.Complex) &&
(collectionType == null || collectionType.ElementType.TypeKind() != EdmTypeKind.Complex) &&
(primitiveType == null || primitiveType.TypeKind != EdmTypeKind.Primitive) &&
(dynamicPath == null || tokenIn.NextToken == null))
{
break;
}
NonSystemToken nextToken = tokenIn.NextToken as NonSystemToken;
if (nextToken == null)
{
break;
}
if (UriParserHelper.IsAnnotation(nextToken.Identifier))
{
lastSegment = SelectPathSegmentTokenBinder.ConvertNonTypeTokenToSegment(nextToken, this.model,
currentLevelType, resolver, null);
}
else if (primitiveType == null && dynamicPath == null)
{
// This means last segment a collection of complex type,
// current segment can only be type cast and cannot be property name.
if (currentLevelType == null)
{
currentLevelType = collectionType.ElementType.Definition as IEdmStructuredType;
}
// If there is no collection type in the path yet, will try to bind property for the next token
// first try bind the segment as property.
lastSegment = SelectPathSegmentTokenBinder.ConvertNonTypeTokenToSegment(nextToken, this.model,
currentLevelType, resolver, null);
}
else
{
// determine whether we are looking at a type cast or a dynamic path segment.
EdmPrimitiveTypeKind nextTypeKind = EdmCoreModel.Instance.GetPrimitiveTypeKind(nextToken.Identifier);
IEdmPrimitiveType castType = EdmCoreModel.Instance.GetPrimitiveType(nextTypeKind);
if (castType != null)
{
lastSegment = new TypeSegment(castType, castType, null);
}
else if (dynamicPath != null)
{
lastSegment = new DynamicPathSegment(nextToken.Identifier);
}
else
{
throw new ODataException(ODataErrorStrings.SelectBinder_MultiLevelPathInSelect);
}
}
// then try bind the segment as type cast.
if (lastSegment == null)
{
IEdmStructuredType typeFromNextToken =
UriEdmHelpers.FindTypeFromModel(this.model, nextToken.Identifier, this.resolver) as
IEdmStructuredType;
if (typeFromNextToken.IsOrInheritsFrom(currentLevelType))
{
lastSegment = new TypeSegment(typeFromNextToken, /*entitySet*/ null);
}
}
// type cast failed too.
if (lastSegment == null)
{
break;
}
// try move to and add next path segment.
tokenIn = nextToken;
pathSoFar.Add(lastSegment);
}
}
ODataSelectPath selectedPath = new ODataSelectPath(pathSoFar);
var selectionItem = new PathSelectItem(selectedPath);
// non-navigation cases do not allow further segments in $select.
if (tokenIn.NextToken != null)
{
throw new ODataException(ODataErrorStrings.SelectBinder_MultiLevelPathInSelect);
}
// if the selected item is a nav prop, then see if its already there before we add it.
NavigationPropertySegment trailingNavPropSegment = selectionItem.SelectedPath.LastSegment as NavigationPropertySegment;
if (trailingNavPropSegment != null)
{
if (this.expandClauseToDecorate.SelectedItems.Any(x => x is PathSelectItem &&
((PathSelectItem)x).SelectedPath.Equals(selectedPath)))
{
return;
}
}
this.expandClauseToDecorate.AddToSelectedItems(selectionItem);
}
/// <summary>
/// Translate a TypeSegment
/// </summary>
/// <param name="segment">the segment to Translate</param>
/// <returns>Defined by the implementer</returns>
public virtual T Translate(TypeSegment segment)
{
throw new NotImplementedException();
}
/// <summary>
/// Get sub select and expand clause by property name, if the propertyname is in form of TypeCast/Property, the typeSegment would also be returned.
/// </summary>
/// <param name="clause">The root clause.</param>
/// <param name="propertyName">The property name to navigate to.</param>
/// <param name="subSelectExpand">The sub select and expand clause under sub property.</param>
/// <param name="typeSegment">Type cast segment, if exists.</param>
internal static void GetSubSelectExpandClause(this SelectExpandClause clause, string propertyName, out SelectExpandClause subSelectExpand, out TypeSegment typeSegment)
{
subSelectExpand = null;
typeSegment = null;
ExpandedNavigationSelectItem selectedItem = clause
.SelectedItems
.OfType <ExpandedNavigationSelectItem>()
.FirstOrDefault(
m => m.PathToNavigationProperty.LastSegment != null &&
m.PathToNavigationProperty.LastSegment.TranslateWith(PathSegmentToStringTranslator.Instance) == propertyName);
if (selectedItem != null)
{
subSelectExpand = selectedItem.SelectAndExpand;
typeSegment = selectedItem.PathToNavigationProperty.FirstSegment as TypeSegment;
}
}
/// <summary>
/// Determine the NavigationSource of a TypeSegment
/// </summary>
/// <param name="segment">The TypeSegment to look in.</param>
/// <returns>The IEdmNavigationSource of this TypeSegment</returns>
/// <exception cref="System.ArgumentNullException">Throws if the input segment is null.</exception>
public override IEdmNavigationSource Translate(TypeSegment segment)
{
ExceptionUtils.CheckArgumentNotNull(segment, "segment");
return(segment.NavigationSource);
}
