org.jopendocument.dom.spreadsheet.Cell Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jOpenDocument Show documentation
Show all versions of jOpenDocument Show documentation
jOpenDocument is a free library for developers looking to use
Open Document files without OpenOffice.org.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2013 jOpenDocument, by ILM Informatique. All rights reserved.
*
* The contents of this file are subject to the terms of the GNU
* General Public License Version 3 only ("GPL").
* You may not use this file except in compliance with the License.
* You can obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
* See the License for the specific language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each file.
*
*/
/*
* Cell created on 10 décembre 2005
*/
package org.jopendocument.dom.spreadsheet;
import org.jopendocument.dom.ODDocument;
import org.jopendocument.dom.ODValueType;
import org.jopendocument.dom.StyleDesc;
import org.jopendocument.dom.XMLFormatVersion;
import org.jopendocument.dom.XMLVersion;
import org.jopendocument.dom.text.TextNode;
import java.util.regex.Pattern;
import org.jdom.Element;
import org.jdom.Namespace;
/**
* A cell in a calc document. If you want to change a cell value you must obtain a MutableCell.
*
* @author Sylvain
* @param type of document
*/
public class Cell extends TableCalcNode {
private static boolean OO_MODE = true;
// from §5.12 of OpenDocument-v1.2-cs01-part2
// Error ::= '#' [A-Z0-9]+ ([!?] | ('/' ([A-Z] | ([0-9] [!?]))))
// we added an optional space before the marks to support OpenOffice/LibreOffice (at least until
// 3.4)
private static final Pattern ErrorPattern = Pattern.compile("#[A-Z0-9]+( ?[!?]|(/([A-Z]|([0-9] ?[!?]))))");
/**
* Set whether {@link #getTextValue()} parses strings using the standard way or using the
* OpenOffice.org way.
*
* @param ooMode true if strings should be parsed the OO way.
* @see #getTextValue(boolean)
*/
public static void setTextValueMode(boolean ooMode) {
OO_MODE = ooMode;
}
public static boolean getTextValueMode() {
return OO_MODE;
}
static final Element createEmpty(XMLVersion ns) {
return createEmpty(ns, 1);
}
static final Element createEmpty(XMLVersion ns, int count) {
final Element e = new Element("table-cell", ns.getTABLE());
if (count > 1)
e.setAttribute("number-columns-repeated", count + "", ns.getTABLE());
return e;
}
private final Row row;
Cell(Row parent, Element elem, StyleDesc styleDesc) {
super(parent.getODDocument(), elem, styleDesc);
this.row = parent;
}
protected final Row getRow() {
return this.row;
}
protected final XMLVersion getNS() {
return this.getODDocument().getVersion();
}
protected final Namespace getValueNS() {
final XMLVersion ns = this.getNS();
return ns == XMLVersion.OD ? ns.getOFFICE() : ns.getTABLE();
}
protected final String getType() {
return this.getElement().getAttributeValue("value-type", getValueNS());
}
public final ODValueType getValueType() {
final String type = this.getType();
return type == null ? null : ODValueType.get(type);
}
// cannot resolve our style since a single instance of Cell is used for all
// repeated and thus if we need to check table-column table:default-cell-style-name
// we wouldn't know which column to check.
@Override
protected String getStyleName() {
throw new UnsupportedOperationException("cannot resolve our style, use MutableCell");
}
String getStyleAttr() {
return this.getElement().getAttributeValue("style-name", getNS().getTABLE());
}
private final String getValue(String attrName) {
return this.getElement().getAttributeValue(attrName, getValueNS());
}
public Object getValue() {
final ODValueType vt = this.getValueType();
if (vt == null || vt == ODValueType.STRING) {
// ATTN oo generates string value-types w/o any @string-value
final String attr = vt == null ? null : this.getValue(vt.getValueAttribute());
if (attr != null)
return attr;
else {
return getTextValue();
}
} else {
return vt.parse(this.getValue(vt.getValueAttribute()));
}
}
/**
* Calls {@link #getTextValue(boolean)} using {@link #getTextValueMode()}.
*
* @return a string for the content of this cell.
*/
public String getTextValue() {
return this.getTextValue(getTextValueMode());
}
/**
* Return the text value of this cell. This is often the formatted string of a value, e.g.
* "11 novembre 2009" for a date. This method doesn't just return the text content it also
* parses XML elements (like paragraphs, tabs and line-breaks). For the differences between the
* OO way (as of 3.1) and the OpenDocument way see section 5.1.1 White-space Characters of
* OpenDocument-v1.0-os and OpenDocument-v1.2-part1. In essence OpenOffice never trim strings.
*
* @param ooMode whether to use the OO way or the standard way.
* @return a string for the content of this cell.
*/
public String getTextValue(final boolean ooMode) {
return TextNode.getChildrenCharacterContent(this.getElement(), getODDocument().getFormatVersion(), ooMode);
}
public final String getFormula() {
return this.getElement().getAttributeValue("formula", getTABLE());
}
/**
* Tries to find out if this cell computation resulted in an error. This method cannot be robust
* since there's no error attribute in OpenDocument, we must match the value of the cell against
* a pattern. E.g. whether a cell has '=A0' for formula or '= "#N" & "/A"', this method will
* return a non-null error.
*
* @return the error or null.
*/
public String getError() {
// to differentiate between the result of a computation and the user having typed '#N/A'
// (this is because per §4.6 of OpenDocument-v1.2-cs01-part2 : if an error value is the
// result of a cell computation it shall be stored as if it was a string.)
if (getFormula() == null)
return null;
final String textValue = getTextValue();
// OpenDocument 1.1 didn't specify errors
return (XMLFormatVersion.get(XMLVersion.OD, "1.1").equals(getODDocument().getFormatVersion()) && textValue.equals("#NA")) || ErrorPattern.matcher(textValue).matches() ? textValue : null;
}
public boolean isValid() {
return !this.isCovered();
}
protected final boolean isCovered() {
return this.getElement().getName().equals("covered-table-cell");
}
public final boolean isEmpty() {
return this.getValueType() == null && this.getElement().getContentSize() == 0;
}
public final int getColumnsSpanned() {
// from 8.1.3 Table Cell
return Integer.parseInt(this.getElement().getAttributeValue("number-columns-spanned", getNS().getTABLE(), "1"));
}
public final int getRowsSpanned() {
// from 8.1.3 Table Cell
return Integer.parseInt(this.getElement().getAttributeValue("number-rows-spanned", getNS().getTABLE(), "1"));
}
protected final boolean coversOtherCells() {
return getColumnsSpanned() > 1 || getRowsSpanned() > 1;
}
}