aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/poi/ss/util
diff options
context:
space:
mode:
authorYegor Kozlov <yegor@apache.org>2011-06-06 09:02:08 +0000
committerYegor Kozlov <yegor@apache.org>2011-06-06 09:02:08 +0000
commite229a9e472fa5687a378617e8d5965dd6c50fbeb (patch)
tree3f2d01070e33012260c5505c2c2d0325b9287df3 /src/java/org/apache/poi/ss/util
parent8b85912bed56ba737547bfcbbdc74c66f2ff94d2 (diff)
downloadpoi-e229a9e472fa5687a378617e8d5965dd6c50fbeb.tar.gz
poi-e229a9e472fa5687a378617e8d5965dd6c50fbeb.zip
Bug 51196: more progress with Spreadsheet Chart API
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1132553 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/java/org/apache/poi/ss/util')
-rw-r--r--src/java/org/apache/poi/ss/util/DataMarker.java87
1 files changed, 87 insertions, 0 deletions
diff --git a/src/java/org/apache/poi/ss/util/DataMarker.java b/src/java/org/apache/poi/ss/util/DataMarker.java
new file mode 100644
index 0000000000..628a975aaa
--- /dev/null
+++ b/src/java/org/apache/poi/ss/util/DataMarker.java
@@ -0,0 +1,87 @@
+/*
+ * ====================================================================
+ * 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.poi.ss.util;
+
+import org.apache.poi.ss.usermodel.Sheet;
+
+/**
+ * Represents data marker used in charts.
+ * @author Roman Kashitsyn
+ */
+public class DataMarker {
+
+ private Sheet sheet;
+ private CellRangeAddress range;
+
+ /**
+ * @param sheet the sheet where data located.
+ * @param range the range within that sheet.
+ */
+ public DataMarker(Sheet sheet, CellRangeAddress range) {
+ this.sheet = sheet;
+ this.range = range;
+ }
+
+ /**
+ * Returns the sheet marker points to.
+ * @return sheet marker points to.
+ */
+ public Sheet getSheet() {
+ return sheet;
+ }
+
+ /**
+ * Sets sheet marker points to.
+ * @param sheet new sheet for the marker.
+ */
+ public void setSheet(Sheet sheet) {
+ this.sheet = sheet;
+ }
+
+ /**
+ * Returns range of the marker.
+ * @return range of cells marker points to.
+ */
+ public CellRangeAddress getRange() {
+ return range;
+ }
+
+ /**
+ * Sets range of the marker.
+ * @param range new range for the marker.
+ */
+ public void setRange(CellRangeAddress range) {
+ this.range = range;
+ }
+
+ /**
+ * Formats data marker using canonical format, for example
+ * `SheetName!$A$1:$A$5'.
+ * @return formatted data marker.
+ */
+ public String formatAsString() {
+ String sheetName = (sheet == null) ? (null) : (sheet.getSheetName());
+ if (range == null) {
+ return null;
+ } else {
+ return range.formatAsString(sheetName, true);
+ }
+ }
+}