IPropertyExpression.cs

// 
// IPropertyExpression.cs
// 
// Copyright (c) 2017 Couchbase, Inc All rights reserved.
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// 

using JetBrains.Annotations;

namespace Couchbase.Lite.Query
{
    /// <summary>
    /// An interface for an expression that will retrieve a property
    /// from a keypath
    /// </summary>
    public interface IPropertyExpression : IExpression
    {
        #region Public Methods

        /// <summary>
        /// Specifies where to retrieve the property from (necessary
        /// in instances where the query is coming from multiple sources)
        /// </summary>
        /// <param name="alias">The alias of the source to retrieve from</param>
        /// <returns>The expression, for further processing</returns>
        [NotNull]
        IExpression From([NotNull]string alias);

        #endregion
    }
}