com.gemstone.gemfire.cache.FixedPartitionResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
There is a newer version: 2.0-BETA
/*
 * Copyright (c) 2010-2015 Pivotal Software, 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.cache;

import java.util.Set;

/**
 * Implementers of interface FixedPartitionResolver helps to
 * achieve explicit mapping of a "user defined" partition to a data member node.
 * 
 * GemFire uses the partition name returned by {@link FixedPartitionResolver#getPartitionName(EntryOperation, Set)} to determine on
 * which member the data is being managed. Say, for example, you want to
 * partition all Trades according to quarters. You can implement
 * FixedPartitionResolver to get the name of the quarter based on the date given
 * as part of {@link com.gemstone.gemfire.cache.EntryOperation}.
 * 
 * 
 * public class QuarterPartitionResolver implements FixedPartitionResolver{

 *     public String getPartitionName(EntryOperation opDetails, Set
 * allAvailablePartitions) {

 *     Date date = sdf.parse((String)opDetails.getKey());

 *     Calendar cal = Calendar.getInstance();

 *     cal.setTime(date);

 *     int month = cal.get(Calendar.MONTH);

 *     if (month == 0 || month == 1 || month == 2) {

 *       return "Quarter1";

 *     }

 *     else if (month == 3 || month == 4 || month == 5) {

 *       return "Quarter2";

 *     }

 *     else if (month == 6 || month == 7 || month == 8) {

 *       return "Quarter3";

 *     }

 *     else if (month == 9 || month == 10 || month == 11) {

 *       return "Quarter4";

 *     }

 *     else {

 *       return "Invalid Quarter";

 *     }

 *   }

 *
 * @see PartitionResolver
 * @author kbachhav
 * @since 6.6
 *
 * 
 */
public interface FixedPartitionResolver extends PartitionResolver {

  /**
   * This method is used to get the name of the partition for the given entry
   * operation.
   * 
   * @param opDetails
   *          the details of the entry operation e.g. {@link Region#get(Object)}
   * @param targetPartitions
   *          represents all the available primary partitions on the nodes
   * 
   * @return partition-name associated with node which allows mapping of given
   *         data to user defined partition
   */
  public String getPartitionName(EntryOperation opDetails,
      Set targetPartitions);
}