com.gemstone.gemfire.internal.admin.CompoundEntrySnapshot 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.internal.admin;

import com.gemstone.gemfire.internal.i18n.LocalizedStrings;

import java.util.*;
//import com.gemstone.gemfire.cache.*;

/**
 * Presents an amalgam snapshot of all the {@linkplain
 * com.gemstone.gemfire.cache.Region.Entry regions entries} in a
 * distributed system.
 */
public class CompoundEntrySnapshot implements EntrySnapshot {
  private static final long serialVersionUID = 5776382582897895718L;
  /** The key ("name") of the Region entry */
  private Object name;
  
  private long lastModifiedTime = 0L; //the latest modified time
  private long lastAccessTime   = 0L; //the latest access time
  private long numHits          = 0L; //sum of all hits
  private long numMisses        = 0L; //sum of all misses
  private float hitRatio        = 0f; //calculated from all
  private long hitResponders    = 0;
  private double hitRatioSum    = 0.0;
  //private Map individuals      = new HashMap();
  private Set allValues        = new HashSet();
  private Set allUserAttributes = new HashSet();


  /**
   * Creates a CompoundEntrySnapshot for the region entry
   * with the given key ("name").
   */
  public CompoundEntrySnapshot(Object entryName) {
    this.name = entryName;
  }

  /**
   * Amalgamates an EntrySnapshot into this
   * CompoundEntrySnapshot. 
   *
   * @param systemEntity
   *        The member of the distributed system that sent the
   *        snapshot
   * @param snap
   *        The snapshot to be amalgamated
   *
   * @throws IllegalArgumentException
   *         If snap is for a region entry other than the
   *         one amalgamated by this snapshot.
   */
  public void addCache(GemFireVM systemEntity, EntrySnapshot snap) {
    if (!snap.getName().equals(this.name)) {
      throw new IllegalArgumentException(LocalizedStrings.CompoundEntrySnapshot_ALL_SNAPSHOTS_IN_A_COMPOUND_SNAPSHOT_MUST_HAVE_THE_SAME_NAME.toLocalizedString());
    }
    //individuals.put(systemEntity, snap);

    Object value = snap.getValue();
    if (value != null) {
      allValues.add(value.toString());
    } else {
      allValues.add("null");
    }
    Object userAttribute = snap.getUserAttribute();
    if (userAttribute != null) {
      allUserAttributes.add(userAttribute.toString());
    } else {
      allUserAttributes.add("null");
    }
    
    long modified = snap.getLastModifiedTime();
    if (modified > 0 && modified > this.lastModifiedTime) {
      this.lastModifiedTime = modified;
    }

    long access = snap.getLastAccessTime();
    if (access > 0 && access > this.lastAccessTime) {
      this.lastAccessTime = access;
    }

    long hitCount = snap.getNumberOfHits();
    if (hitCount > 0) {
      this.numHits += hitCount;
    }

    long missCount = snap.getNumberOfMisses();
    if (missCount > 0) {
      this.numMisses += missCount;
    }

    float hitRatio = snap.getHitRatio();
    if (hitRatio >= 0.00) {
      hitResponders++;
      hitRatioSum += hitRatio;
      this.hitRatio = (float)(hitRatioSum/hitResponders);      
    }

  }  

  /**
   * Returns the name ("key") of the region entry amalgamated by this
   * snapshot. 
   */
  public Object getName() {
    return this.name;
  }

  /**
   * Since this snapshot does not represent a single region entry,
   * this method returns null.
   */
  public Object getValue() {
    return null;
  }

  /**
   * Since this snapshot does not represent a single region entry,
   * this method returns null.
   */
  public Object getUserAttribute() {
    return null;
  }

  /**
   * Returns an Iterator containing the value of this
   * region entry across all Region instances in the
   * distributed system.
   */
  public Iterator getAllValues() {
    return allValues.iterator();
  }

  /**
   * Returns an Iterator containing the
   * userAttributes of this region entry across all
   * Region instances in the distributed system.
   */
  public Iterator getAllUserAttributes() {
    return allUserAttributes.iterator();
  }

  /**
   * Returns the most recent lastModifiedTime of any
   * instance of this snapshot's region entry across the
   * distributed system.
   */
  public long getLastModifiedTime() {
    return this.lastModifiedTime;
  }

  /**
   * Returns the most recent lastAccessTime of any
   * instance of this snapshot's region entry across the
   * distributed system.
   */
  public long getLastAccessTime() {
    return this.lastAccessTime;
  }

  /**
   * Returns the cumulative number of hits across all instances of the
   * snapshot's region entry.
   */
  public long getNumberOfHits() {
    return this.numHits;
  }

  /**
   * Returns the cumulative number of misses across all instances of
   * this snapshot's region entry.
   */
  public long getNumberOfMisses() {
    return this.numMisses;
  }
  
  /**
   * Returns the aggregate hit ratio across all instances of this
   * snapshot's region entry.
   */
  public float getHitRatio() {
    return this.hitRatio;
  }

}