AggregateFacet.cs

/* Copyright 2016-present MongoDB Inc.
*
* 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.
*/

usingSystem;
usingMongoDB.Bson;
usingMongoDB.Bson.Serialization;
usingMongoDB.Driver.Core.Misc;
usingMongoDB.Driver.Linq;

namespaceMongoDB.Driver
{
/// <summary>
/// Represents static methods for creating facets.
/// </summary>
publicstaticclassAggregateFacet
{
/// <summary>
/// Creates a new instance of the <see cref="AggregateFacet{TInput, TOutput}" /> class.
/// </summary>
/// <typeparam name="TInput">The type of the input documents.</typeparam>
/// <typeparam name="TOutput">The type of the output documents.</typeparam>
/// <param name="name">The facet name.</param>
/// <param name="pipeline">The facet pipeline.</param>
/// <returns>
/// A new instance of the <see cref="AggregateFacet{TInput, TOutput}" /> class
/// </returns>
publicstaticAggregateFacet<TInput,TOutput>Create<TInput,TOutput>(stringname,PipelineDefinition<TInput,TOutput>pipeline)
{
returnnewAggregateFacet<TInput,TOutput>(name,pipeline);
}
}

/// <summary>
/// Represents a facet to be passed to the Facet method.
/// </summary>
/// <typeparam name="TInput">The type of the input documents.</typeparam>
publicabstractclassAggregateFacet<TInput>
{
/// <summary>
/// Initializes a new instance of the <see cref="AggregateFacet{TInput}"/> class.
/// </summary>
/// <param name="name">The facet name.</param>
protectedAggregateFacet(stringname)
{
Name=Ensure.IsNotNull(name,nameof(name));
}

/// <summary>
/// Gets the facet name.
/// </summary>
publicstringName{get;privateset;}

/// <summary>
/// Gets the output serializer.
/// </summary>
publicabstractIBsonSerializerOutputSerializer{get;}

/// <summary>
/// Gets the type of the output documents.
/// </summary>
publicabstractTypeOutputType{get;}

/// <summary>
/// Renders the facet pipeline.
/// </summary>
/// <param name="args">The render arguments.</param>
/// <returns>A <see cref="BsonValue"/>.</returns>
publicabstractBsonArrayRenderPipeline(RenderArgs<TInput>args);
}

/// <summary>
/// Represents a facet to be passed to the Facet method.
/// </summary>
/// <typeparam name="TInput">The type of the input documents.</typeparam>
/// <typeparam name="TOutput">The type of the output documents.</typeparam>
publicclassAggregateFacet<TInput,TOutput>:AggregateFacet<TInput>
{
/// <summary>
/// Initializes a new instance of the <see cref="AggregateFacet{TInput, TOutput}"/> class.
/// </summary>
/// <param name="name">The facet name.</param>
/// <param name="pipeline">The facet pipeline.</param>
publicAggregateFacet(stringname,PipelineDefinition<TInput,TOutput>pipeline)
:base(name)
{
Pipeline=Ensure.IsNotNull(pipeline,nameof(pipeline));
}

/// <inheritdoc/>
publicoverrideIBsonSerializerOutputSerializer=>Pipeline.OutputSerializer;

/// <inheritdoc/>
publicoverrideTypeOutputType=>typeof(TOutput);

/// <summary>
/// Gets the facet pipeline.
/// </summary>
publicPipelineDefinition<TInput,TOutput>Pipeline{get;privateset;}

/// <inheritdoc/>
publicoverrideBsonArrayRenderPipeline(RenderArgs<TInput>args)
{
varrenderedPipeline=Pipeline.Render(args);
returnnewBsonArray(renderedPipeline.Documents);
}
}
}