org.opencms.staticexport.CmsLinkTable Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.staticexport;
import org.opencms.relations.CmsLink;
import org.opencms.relations.CmsRelationType;
import java.util.Comparator;
import java.util.Iterator;
import java.util.Map;
import java.util.TreeMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang.BooleanUtils;
import com.google.common.collect.ComparisonChain;
/**
* Maintains a table of links for an element of a CmsXmlPage.
*
* @since 6.0.0
*/
public class CmsLinkTable {
/**
* Comparator used to deterministically order the link table.
*/
public static class LinkKeyComparator implements Comparator {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(String a, String b) {
if ((a == null) || (b == null)) {
// null is "less" than any other string
return BooleanUtils.toInteger(b == null) - BooleanUtils.toInteger(a == null);
}
Matcher matcherA = LINK_PATTERN.matcher(a);
Matcher matcherB = LINK_PATTERN.matcher(b);
matcherA.find();
matcherB.find();
String nameA = matcherA.group(1);
// prepend "0" so we don't get an exception for the empty string
int indexA = Integer.parseInt("0" + matcherA.group(2));
String nameB = matcherB.group(1);
int indexB = Integer.parseInt("0" + matcherB.group(2));
int result = ComparisonChain.start().compare(nameA, nameB).compare(indexA, indexB).compare(a, b).result();
return result;
}
}
/** Prefix to identify a link in the content. */
private static final String LINK_PREFIX = "link";
/** Pattern used to extract the index and the part before the index from a link id. */
public static final Pattern LINK_PATTERN = Pattern.compile("^(.*?)([0-9]*)$");
/** The map to store the link table in. */
private Map m_linkTable;
/**
* Creates a new CmsLinkTable.
*/
public CmsLinkTable() {
m_linkTable = new TreeMap(new LinkKeyComparator());
}
/**
* Adds a new link with a given internal name and internal flag to the link table.
*
* @param link the CmsLink to add
* @return the new link entry
*/
public CmsLink addLink(CmsLink link) {
m_linkTable.put(link.getName(), link);
return link;
}
/**
* Adds a new link to the link table.
*
* @param type type of the link
* @param targetUri link destination
* @param internal flag to indicate if the link is a local link
*
* @return the new link entry
*/
public CmsLink addLink(CmsRelationType type, String targetUri, boolean internal) {
CmsLink link = new CmsLink(LINK_PREFIX + m_linkTable.size(), type, targetUri, internal);
m_linkTable.put(link.getName(), link);
return link;
}
/**
* Returns the CmsLink Entry for a given name.
*
* @param name the internal name of the link
* @return the CmsLink entry
*/
public CmsLink getLink(String name) {
return m_linkTable.get(name);
}
/**
* Returns if the link table is empty.
*
* @return true if the link table is empty, false otherwise
*/
public boolean isEmpty() {
return m_linkTable.isEmpty();
}
/**
* Returns an iterator over the links in the table.
*
* The objects iterated are of type {@link CmsLink}.
*
* @return a string iterator for internal link names
*/
public Iterator iterator() {
return m_linkTable.values().iterator();
}
/**
* Returns the size of this link table.
*
* @return the size of this link table
*/
public int size() {
return m_linkTable.size();
}
}