/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (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, 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.relations;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.CmsVfsResourceNotFoundException;
import org.opencms.main.CmsException;
import org.opencms.util.CmsUUID;
import java.util.Comparator;
/**
* A relation between two opencms resources.<p>
*
* @since 6.3.0
*/
public class CmsRelation {
/**
* A comparator for the source & target path plus the relation type of 2 relations.<p>
*/
public static final Comparator<CmsRelation> COMPARATOR = new Comparator<CmsRelation>() {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(CmsRelation r1, CmsRelation r2) {
if (r1 == r2) {
return 0;
}
String p1 = r1.getSourcePath() + r1.getTargetPath() + r1.getType().getId();
String p2 = r2.getSourcePath() + r2.getTargetPath() + r2.getType().getId();
return p1.compareTo(p2);
}
};
/** Default value for undefined Strings. */
private static final String UNDEF = "";
/** Cached hash code. */
private int m_hashCode;
/** The structure id of the source resource. */
private final CmsUUID m_sourceId;
/** The path of the source resource. */
private final String m_sourcePath;
/** The structure id of the target resource. */
private final CmsUUID m_targetId;
/** The path of the target resource. */
private final String m_targetPath;
/** The relation type. */
private final CmsRelationType m_type;
/**
* Creates a new relation object of the given type between the given resources.<p>
*
* @param source the source resource
* @param target the target resource
* @param type the relation type
*/
public CmsRelation(CmsResource source, CmsResource target, CmsRelationType type) {
this(source.getStructureId(), source.getRootPath(), target.getStructureId(), target.getRootPath(), type);
}
/**
* Base constructor.<p>
*
* @param sourceId the source structure id
* @param sourcePath the source path
* @param targetId the target structure id
* @param targetPath the target path
* @param type the relation type
*/
public CmsRelation(CmsUUID sourceId, String sourcePath, CmsUUID targetId, String targetPath, CmsRelationType type) {
// make sure no value can ever be null
m_sourceId = ((sourceId != null) ? sourceId : CmsUUID.getNullUUID());
m_sourcePath = ((sourcePath != null) ? sourcePath : UNDEF);
m_targetId = ((targetId != null) ? targetId : CmsUUID.getNullUUID());
m_targetPath = ((targetPath != null) ? targetPath : UNDEF);
m_type = ((type != null) ? type : CmsRelationType.XML_WEAK);
}
/**
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof CmsRelation) {
CmsRelation other = (CmsRelation)obj;
return (m_type == other.m_type)
// && (m_dateBegin == other.m_dateBegin)
// && (m_dateEnd == other.m_dateEnd)
&& (m_sourcePath.equals(other.m_sourcePath) || m_sourceId.equals(other.m_sourceId))
&& (m_targetPath.equals(other.m_targetPath) || m_targetId.equals(other.m_targetId));
}
return false;
}
/**
* Returns the source resource when possible to read with the given filter.<p>
*
* @param cms the current user context
* @param filter the filter to use
*
* @return the source resource
*
* @throws CmsException if something goes wrong
*/
public CmsResource getSource(CmsObject cms, CmsResourceFilter filter) throws CmsException {
try {
// first look up by id
return cms.readResource(getSourceId(), filter);
} catch (CmsVfsResourceNotFoundException e) {
// then look up by name, but from the root site
String storedSiteRoot = cms.getRequestContext().getSiteRoot();
try {
cms.getRequestContext().setSiteRoot("");
return cms.readResource(getSourcePath(), filter);
} finally {
cms.getRequestContext().setSiteRoot(storedSiteRoot);
}
}
}
/**
* Returns the structure id of the source resource.<p>
*
* @return the structure id of the source resource
*/
public CmsUUID getSourceId() {
return m_sourceId;
}
/**
* Returns the path of the source resource.<p>
*
* @return the path of the source resource
*/
public String getSourcePath() {
return m_sourcePath;
}
/**
* Returns the target resource when possible to read with the given filter.<p>
*
* @param cms the current user context
* @param filter the filter to use
*
* @return the target resource
*
* @throws CmsException if something goes wrong
*/
public CmsResource getTarget(CmsObject cms, CmsResourceFilter filter) throws CmsException {
try {
// first look up by id
return cms.readResource(getTargetId(), filter);
} catch (CmsVfsResourceNotFoundException e) {
// then look up by name, but from the root site
String storedSiteRoot = cms.getRequestContext().getSiteRoot();
try {
cms.getRequestContext().setSiteRoot("");
return cms.readResource(getTargetPath(), filter);
} finally {
cms.getRequestContext().setSiteRoot(storedSiteRoot);
}
}
}
/**
* Returns the structure id of the target resource.<p>
*
* @return the structure id of the target resource
*/
public CmsUUID getTargetId() {
return m_targetId;
}
/**
* Returns the path of the target resource.<p>
*
* @return the path of the target resource
*/
public String getTargetPath() {
return m_targetPath;
}
/**
* Returns the relation type.<p>
*
* @return the relation type
*/
public CmsRelationType getType() {
return m_type;
}
/**
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
if (m_hashCode == 0) {
// calculate hash code only once
final int PRIME = 31;
int result = 1;
result = PRIME * result + ((m_sourceId == null) ? 0 : m_sourceId.hashCode());
result = PRIME * result + ((m_sourcePath == null) ? 0 : m_sourcePath.hashCode());
result = PRIME * result + ((m_targetId == null) ? 0 : m_targetId.hashCode());
result = PRIME * result + ((m_targetPath == null) ? 0 : m_targetPath.hashCode());
result = PRIME * result + ((m_type == null) ? 0 : m_type.hashCode());
m_hashCode = result;
}
return m_hashCode;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuffer str = new StringBuffer();
str.append("CmsRelation [");
str.append("source id: ").append(m_sourceId).append(", ");
str.append("source path: ").append(m_sourcePath).append(", ");
str.append("target id: ").append(m_targetId).append(", ");
str.append("target path: ").append(m_targetPath).append(", ");
str.append("type: ").append(m_type);
str.append("]");
return str.toString();
}
}