clicache/src/IPartitionResolver.hpp

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

#pragma once


#include "geode_defs.hpp"
//#include "ICacheableKey.hpp"

#include "EntryEvent.hpp"

namespace Apache
{
  namespace Geode
  {
    namespace Client
    {

      interface class ISerializable;


      /// <summary>
      /// Implementers of interface <code>PartitionResolver</code> enable custom
      /// partitioning on the <code>PartitionedRegion</code>.
      /// </summary>
      /// <remarks>
      /// 1. The Key class or callback arg can implement PartitionResolver interface to
      /// enable custom partitioning OR
      /// 2. Configure your own PartitionResolver class in partition attributes (For
      /// instance when the Key is a primitive type or String) Implement the
      /// appropriate equals - For all implementations, you need to be sure to code the
      /// class equals method so it properly verifies equality for the
      /// PartitionResolver implementation. This might mean verifying that class names
      /// are the same or that the returned routing objects are the same etc.. When you
      /// initiate the partitioned region on multiple nodes, Geode uses the equals
      /// method to ensure you are using the same PartitionResolver implementation for
      /// all of the nodes for the region.
      /// Geode uses the routing object's hashCode to determine where the data is
      /// being managed. Say, for example, you want to colocate all Trades by month and
      /// year.The key is implemented by TradeKey class which also implements the
      /// PartitionResolver interface.
      /// public class TradeKey implements PartitionResolver {<br>
      /// &nbsp &nbsp private String tradeID;<br>
      /// &nbsp &nbsp private Month month ;<br>
      /// &nbsp &nbsp private Year year ;<br>
      ///
      /// &nbsp &nbsp public TradingKey(){ } <br>
      /// &nbsp &nbsp public TradingKey(Month month, Year year){<br>
      /// &nbsp &nbsp &nbsp &nbsp this.month = month;<br>
      /// &nbsp &nbsp &nbsp &nbsp this.year = year;<br>
      /// &nbsp &nbsp } <br>
      /// &nbsp &nbsp public Serializable getRoutingObject(EntryOperation key){<br>
      /// &nbsp &nbsp &nbsp &nbsp return this.month + this.year;<br>
      /// &nbsp &nbsp }<br> }<br>
      ///
      /// In the example above, all trade entries with the same month and year are
      /// guaranteed to be colocated.
      /// </remarks>
      /// <seealso cref="RegionAttributesFactory.SetPartitionResolver" />
      /// <seealso cref="RegionAttributes.PartitionResolver" />
      generic<class TKey, class TValue>
      public interface class IPartitionResolver
      {
      public:

        /// <summary>
        /// Returns the name of the PartitionResolver.
        /// </summary>
        /// <remarks>
        /// <para>
        /// This function does not throw any exception.
        /// </para>
        /// <returns>
        /// the name of the PartitionResolver
        /// </returns>
        /// </remarks>
        String^ GetName();

        /// <summary>
        /// return object associated with entry event which allows the Partitioned Region to store associated data together.
        /// </summary>
        /// <remarks>
        /// throws RuntimeException - any exception thrown will terminate the operation and the exception will be passed to the
        /// calling thread.
        /// </remarks>
        /// <param name="key">
        /// key the detail of the entry event.
        /// </param>

        Object^ GetRoutingObject(EntryEvent<TKey, TValue>^ key);
      };
    }  // namespace Client
  }  // namespace Geode
}  // namespace Apache