Github user joshelser commented on a diff in the pull request:
https://github.com/apache/accumulo/pull/224#discussion_r104506924
--- Diff:
core/src/main/java/org/apache/accumulo/core/client/summary/Summary.java ---
@@ -0,0 +1,127 @@
+/*
+ * 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.
+ */
+
+package org.apache.accumulo.core.client.summary;
+
+import java.util.Map;
+
+import com.google.common.collect.ImmutableMap;
+
+/**
+ * This class encapsulates summary statistics, information about how those
statistics were generated, and information about files the statistics were
obtained
+ * from.
+ *
+ * @see Summarizer
+ * @since 2.0.0
+ */
+public class Summary {
+
+ public static class FileStatistics {
+ private final long total;
+ private final long missing;
+ private final long extra;
+ private final long large;
+
+ private FileStatistics(long total, long missing, long extra, long
large) {
+ this.total = total;
+ this.missing = missing;
+ this.extra = extra;
+ this.large = large;
+ }
+
+ /**
+ * @return The total number of files from which summary information
was obtained.
+ */
+ public long getTotal() {
+ return total;
+ }
+
+ /**
+ * @return The number of files that did not contain the requested
summary information. When this is non-zero, it means that summary counts may be
+ * incomplete.
+ */
+ public long getMissing() {
+ return missing;
+ }
+
+ /**
+ * @return The number of files that had summary information outside of
a tablet or query range boundaries. When this is non-zero, it means that summary
+ * counts may be artificially inflated or contain extraneous
information.
+ */
+ public long getExtra() {
+ return extra;
+ }
+
+ /**
+ * @return The number of files that an attempt was made to generate
summaries, but the summarizer generated a summary that was larger than the
configured
+ * maximum. For these files no summary statistics are stored.
Only the fact that summarization was attempted and failed is stored.
+ * @see
Summarizer.Collector#summarize(org.apache.accumulo.core.client.summary.Summarizer.StatisticConsumer)
+ */
+ public long getLarge() {
+ return large;
+ }
+
+ /**
+ * @return The total number of files that had some kind of issue which
would cause summary statistics to be inaccurate. This is the sum of
+ * {@link #getMissing()}, {@link #getExtra()}, and {{@link
#getLarge()}.
+ */
+ public long getInaccurate() {
+ return getMissing() + getExtra() + getLarge();
+ }
+
+ @Override
+ public String toString() {
+ return String.format("[total:%,d, missing:%,d, extra:%,d,
large:%,d]", total, missing, extra, large);
+ }
+ }
+
+ private final ImmutableMap<String,Long> statistics;
+ private final SummarizerConfiguration config;
+ private final FileStatistics fileStats;
+
+ public Summary(Map<String,Long> summary, SummarizerConfiguration config,
long totalFiles, long filesMissingSummary, long filesWithExtra, long
filesWithLarge) {
+ this.statistics = ImmutableMap.copyOf(summary);
+ this.config = config;
+ this.fileStats = new FileStatistics(totalFiles, filesMissingSummary,
filesWithExtra, filesWithLarge);
+ }
+
+ /**
+ * @return Statistics about the files from which summary statistics were
obtained.
+ */
+ public FileStatistics getFileStatistics() {
+ return fileStats;
+ }
+
+ /**
+ * @return The configuration used to generate and combine the summary
statistics
+ */
+ public SummarizerConfiguration getSummarizerConfiguration() {
+ return config;
+ }
+
+ /**
+ * @return The statistics that were generated and merged by the specfied
{@link Summarizer}.
--- End diff --
Include in the javadoc that the map itself is immutable as a warning.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
