org.jopendocument.dom.StyleDesc Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008 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.
*
*/
package org.jopendocument.dom;
import org.jopendocument.util.CollectionMap;
import org.jopendocument.util.CollectionUtils;
import org.jopendocument.util.cc.ITransformer;
import java.util.Collection;
import java.util.List;
import java.util.Map.Entry;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.Namespace;
import org.jdom.xpath.XPath;
/**
* Describe a family of style.
*
* @author Sylvain CUAZ
*
* @param type of style
*/
public abstract class StyleDesc {
public static StyleDesc copy(final StyleDesc toClone, final XMLVersion version) {
if (toClone instanceof StyleStyleDesc) {
@SuppressWarnings("unchecked")
final StyleDesc res = (StyleDesc) StyleStyleDesc.copy((StyleStyleDesc) toClone, version);
return res;
} else {
final StyleDesc res = new StyleDesc(toClone.getStyleClass(), version, toClone.getElementName(), toClone.getBaseName()) {
@Override
public C create(ODPackage pkg, Element e) {
return toClone.create(pkg, e);
}
};
res.getRefElementsMap().putAll(toClone.getRefElementsMap());
res.getMultiRefElementsMap().putAll(toClone.getMultiRefElementsMap());
return res;
}
}
static private final ITransformer Q_NAME_TRANSF = new ITransformer() {
@Override
public String transformChecked(String input) {
return "name() = '" + input + "'";
}
};
static private final String getXPath(Collection>> entries) {
return CollectionUtils.join(entries, " or ", new ITransformer>, String>() {
@Override
public String transformChecked(Entry> e) {
final String nameTest = CollectionUtils.join(e.getValue(), " or ", Q_NAME_TRANSF);
return "( @" + e.getKey() + " = $name and ( " + nameTest + " ))";
}
});
}
private final Class clazz;
// need version since each one might have different attributes and elements (plus we need it
// anyway for the XPath, otherwise it fails when searching for an inexistant namespace)
private final XMLVersion version;
private Namespace elemNS;
private final String elemName, baseName;
// { attribute -> element }
private final CollectionMap refElements;
private final CollectionMap multiRefElements;
private XPath refXPath;
protected StyleDesc(final Class clazz, final XMLVersion version, String elemName, String baseName, String ns, final List refQNames) {
this(clazz, version, elemName, baseName);
this.getRefElementsMap().putAll(ns + ":style-name", refQNames);
}
protected StyleDesc(final Class clazz, final XMLVersion version, String elemName, String baseName) {
super();
this.clazz = clazz;
this.version = version;
this.elemNS = version.getSTYLE();
this.elemName = elemName;
this.baseName = baseName;
this.refElements = new CollectionMap();
// 4 since they are not common
this.multiRefElements = new CollectionMap(4);
this.refXPath = null;
}
public abstract S create(ODPackage pkg, Element e);
final Class getStyleClass() {
return this.clazz;
}
public final XMLVersion getVersion() {
return this.version;
}
protected final void setElementNS(Namespace elemNS) {
this.elemNS = elemNS;
}
public final Namespace getElementNS() {
return this.elemNS;
}
/**
* The name of the XML element for this type of style.
*
* @return the name of the element, e.g. "style" or "master-page".
*/
public final String getElementName() {
return this.elemName;
}
public final String getBaseName() {
return this.baseName;
}
private final XPath getRefXPath() {
if (this.refXPath == null) {
final String attrOr = "( $includeSingle and " + getXPath(getRefElementsMap().entrySet()) + " )";
final String multiOr;
if (getMultiRefElementsMap().size() == 0)
multiOr = "";
else
multiOr = " or ( $includeMulti and " + getXPath(getMultiRefElementsMap().entrySet()) + " )";
try {
this.refXPath = OOUtils.getXPath("//*[ " + attrOr + multiOr + " ]", this.version);
} catch (JDOMException e) {
throw new IllegalStateException("couldn't create xpath with " + getRefElements(), e);
}
}
return this.refXPath;
}
@SuppressWarnings("unchecked")
final List getReferences(final Document doc, final String name, final boolean wantSingle, boolean wantMulti) {
final XPath xp = this.getRefXPath();
try {
synchronized (xp) {
xp.setVariable("name", name);
xp.setVariable("includeSingle", wantSingle);
xp.setVariable("includeMulti", wantMulti);
return xp.selectNodes(doc);
}
} catch (JDOMException e) {
throw new IllegalStateException("unable to search for occurences of " + this, e);
}
}
/**
* The list of elements that can point to this family of style.
*
* @return a list of qualified names, e.g. ["text:h", "text:p"].
*/
protected final Collection getRefElements() {
return this.getRefElementsMap().values();
}
// e.g. { "text:style-name" -> ["text:h", "text:p"] }
// if a property of the style is changed it will affect only the referent element
protected final CollectionMap getRefElementsMap() {
return this.refElements;
}
// e.g. { "table:default-cell-style-name" -> ["table:table-column", "table:table-row"] }
// if a property of the style is changed it will affect multiple cells even if only one element
// (e.g. a column) references the style
protected final CollectionMap getMultiRefElementsMap() {
return this.multiRefElements;
}
/**
* Resolve the passed style name. Note: this always return the style named name,
* possibly ignoring conditions.
*
* @param pkg the package of the searched for style.
* @param doc the document of the searched for style.
* @param name the name of the style.
* @return the corresponding style, null if not found.
* @see #findStyleForNode(StyledNode, String)
*/
public final S findStyleWithName(final ODPackage pkg, final Document doc, final String name) {
return this.findStyle(pkg, doc, name, null);
}
/**
* Find the style for the passed node. Depending on conditions the returned style might not be
* named name.
*
* @param styledNode needed to evaluate conditions, not null.
* @param name the name of the style.
* @return the corresponding style, null if not found.
* @see #findStyleWithName(ODPackage, Document, String)
*/
public final S findStyleForNode(final StyledNode styledNode, final String name) {
return this.findStyleForNode(styledNode.getODDocument().getPackage(), styledNode.getElement().getDocument(), styledNode, name);
}
public final S findStyleForNode(final ODPackage pkg, final Document doc, final StyledNode styledNode, final String name) {
if (styledNode == null)
throw new NullPointerException("null node");
return this.findStyle(pkg, doc, name, styledNode);
}
/**
* Resolve the passed style name. If styledNode is null the returned
* style will be the one named name otherwise depending on conditions it can be
* another one.
*
* @param pkg the package of the searched for style.
* @param doc the document of the searched for style.
* @param name the name of the style.
* @param styledNode needed to evaluate conditions, can be null.
* @return the corresponding style, null if not found.
*/
private final S findStyle(final ODPackage pkg, final Document doc, final String name, final StyledNode styledNode) {
Element styleElem = pkg.getStyle(doc, this, name);
if (styleElem == null)
return null;
if (styledNode != null && supportConditions()) {
@SuppressWarnings("unchecked")
final List styleMaps = styleElem.getChildren("map", getVersion().getSTYLE());
final Element styleMap = evaluateConditions(styledNode, styleMaps);
if (styleMap != null) {
if (styleElem != styleMap.getParent())
throw new IllegalStateException("map element not in " + styleElem);
styleElem = pkg.getStyle(doc, this, styleMap.getAttributeValue("apply-style-name", getVersion().getSTYLE()));
}
}
return this.create(pkg, styleElem);
}
protected boolean supportConditions() {
return false;
}
protected Element evaluateConditions(final StyledNode styledNode, final List styleMaps) {
return null;
}
public final S createAutoStyle(final ODPackage pkg) {
return this.createAutoStyle(pkg, getBaseName());
}
/**
* Create a new automatic style in the content of pkg.
*
* @param pkg where to add the new style.
* @param baseName the base name for the new style, eg "ce".
* @return the new style, eg named "ce3".
*/
public final S createAutoStyle(final ODPackage pkg, final String baseName) {
final ODXMLDocument xml = pkg.getContent();
final Namespace style = xml.getVersion().getSTYLE();
final Element elem = new Element(getElementName(), style);
this.initStyle(elem);
elem.setAttribute("name", xml.findUnusedName(this, baseName), style);
xml.addAutoStyle(elem);
return this.create(pkg, elem);
}
protected void initStyle(final Element elem) {
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy