org.opencms.file.I_CmsResource 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, 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.file;
import org.opencms.db.CmsResourceState;
import org.opencms.util.CmsUUID;
import java.util.Comparator;
/**
* Common ancestor interface for {@link CmsFile} and {@link CmsFolder}
* as well as for {@Link CmsHistoryFile} and {@link org.opencms.file.history.CmsHistoryFolder}.
*
* @since 8.0.0
*/
public interface I_CmsResource {
/**
* Enumeration for all attributes of a resource.
*/
public enum CmsResourceAttribute {
/** The date of the last modification of the content of a resource. */
dateContent,
/** The date of the creation of a resource. */
dateCreated,
/** The expiration date a resource. */
dateExpired,
/** The date of the last modification of a resource. */
dateLastModified,
/** The release date of a resource. */
dateReleased,
/** The flags of a resource. */
flags,
/** The content length of a resource. */
length,
/** The file name of a resource without parent folders. */
name,
/** The id of the {@link CmsProject} where a resource has been last modified. */
projectLastModified,
/** The id of the database content record of a resource. */
resourceId,
/** The name of a resource with it's full path from the top level root folder. */
rootPath,
/** The number of siblings of a resource, also counting the resource. */
siblingCount,
/** The state of a resource. */
state,
/** The id of the database structure record of a resource. */
structureId,
/** The resource type id for a resource. */
typeId,
/** The id of the {@link CmsUser} who created a resource. */
userCreated,
/** The id of the user who made the last modification on a resource. */
userLastModified,
/** The current version number of a resource. */
version
}
/**
* A comparator for the date last modified of two resources.
*/
Comparator COMPARE_DATE_LAST_MODIFIED = new Comparator() {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(I_CmsResource r1, I_CmsResource r2) {
if (r1 == r2) {
return 0;
}
long date1 = r1.getDateLastModified();
long date2 = r2.getDateLastModified();
return (date1 > date2) ? -1 : (date1 < date2) ? 1 : 0;
}
};
/**
* A comparator for the release date of two resources.
*
* If the release date of a resource is not set, the
* creation date is used instead.
*/
Comparator COMPARE_DATE_RELEASED = new Comparator() {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(I_CmsResource r1, I_CmsResource r2) {
if (r1 == r2) {
return 0;
}
long date1 = r1.getDateReleased();
if (date1 == CmsResource.DATE_RELEASED_DEFAULT) {
// use last modification date if release date is not set
date1 = r1.getDateLastModified();
}
long date2 = r2.getDateReleased();
if (date2 == CmsResource.DATE_RELEASED_DEFAULT) {
// use last modification date if release date is not set
date2 = r2.getDateLastModified();
}
return (date1 > date2) ? -1 : (date1 < date2) ? 1 : 0;
}
};
/**
* A comparator for the root path of two resources.
*/
Comparator COMPARE_ROOT_PATH = new Comparator() {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(I_CmsResource r1, I_CmsResource r2) {
if (r1 == r2) {
return 0;
}
return r1.getRootPath().compareTo(r2.getRootPath());
}
};
/**
* A comparator for the root path of two resources ignoring case differences.
*/
Comparator COMPARE_ROOT_PATH_IGNORE_CASE = new Comparator() {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(I_CmsResource r1, I_CmsResource r2) {
if (r1 == r2) {
return 0;
}
return r1.getRootPath().compareToIgnoreCase(r2.getRootPath());
}
};
/**
* A comparator for the root path of two resources ignoring case differences, putting folders before files.
*/
Comparator COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST = new Comparator() {
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
public int compare(I_CmsResource r1, I_CmsResource r2) {
if (r1 == r2) {
return 0;
}
if (r1.isFolder() && !r2.isFolder()) {
return -1;
} else if (r2.isFolder() && !r1.isFolder()) {
return 1;
}
// if same type, compare the name of the resource
return r1.getRootPath().compareToIgnoreCase(r2.getRootPath());
}
};
/**
* Returns the date of the last modification of the content of this resource.
*
* @return the date of the last modification of the content of this resource
*/
long getDateContent();
/**
* Returns the date of the creation of this resource.
*
* @return the date of the creation of this resource
*/
long getDateCreated();
/**
* Returns the expiration date this resource.
*
* @return the expiration date of this resource
*/
long getDateExpired();
/**
* Returns the date of the last modification of this resource.
*
* @return the date of the last modification of this resource
*/
long getDateLastModified();
/**
* Returns the release date this resource.
*
* @return the release date of this resource
*/
long getDateReleased();
/**
* Returns the flags of this resource.
*
* @return the flags of this resource
*/
int getFlags();
/**
* Returns the content length of this resource.
*
* If the resource is a file, then this is the byte size of the file content.
* If the resource is a folder, then the size is always -1.
*
* @return the content length of this resource
*/
int getLength();
/**
* Returns the file name of this resource without parent folders, for example index.html.
*
* @return the file name of this resource without parent folders
*/
String getName();
/**
* Returns the id of the {@link CmsProject} where this resource has been last modified.
*
* @return the id of the {@link CmsProject} where this resource has been last modified, or null
*/
CmsUUID getProjectLastModified();
/**
* Returns the id of the database content record of this resource.
*
* @return the id of the database content record of this resource
*/
CmsUUID getResourceId();
/**
* Returns the name of this resource with it's full path from the top level root folder,
* for example /sites/default/myfolder/index.html.
*
* @return name of this resource with it's full path from the top level root folder
*/
String getRootPath();
/**
* Returns the number of siblings of this resource, also counting this resource.
*
* If a resource has no sibling, the total sibling count for this resource is 1,
* if a resource has n siblings, the sibling count is n + 1.
*
* @return the number of siblings of this resource, also counting this resource
*/
int getSiblingCount();
/**
* Returns the state of this resource.
*
* @return the state of this resource
*/
CmsResourceState getState();
/**
* Returns the id of the database structure record of this resource.
*
* @return the id of the database structure record of this resource
*/
CmsUUID getStructureId();
/**
* Returns the resource type id for this resource.
*
* @return the resource type id of this resource
*/
int getTypeId();
/**
* Returns the id of the {@link CmsUser} who created this resource.
*
* @return the id of the {@link CmsUser} who created this resource
*/
CmsUUID getUserCreated();
/**
* Returns the id of the {@link CmsUser} who made the last modification on this resource.
*
* @return the id of the {@link CmsUser} who made the last modification on this resource
*/
CmsUUID getUserLastModified();
/**
* Returns the current version number of this resource.
*
* @return the current version number of this resource
*/
int getVersion();
/**
* Returns true if this resource is expired at the given time according to the
* information stored in {@link #getDateExpired()}.
*
* @param time the time to check the expiration date against
*
* @return true if this resource is expired at the given time
*
* @see #isReleased(long)
* @see #isReleasedAndNotExpired(long)
*/
boolean isExpired(long time);
/**
* Returns true if the resource is a file, i.e. can have no sub-resources.
*
* @return true if this resource is a file, false otherwise
*/
boolean isFile();
/**
* Returns true if the resource is a folder, i.e. can have sub-resources.
*
* @return true if this resource is a folder, false otherwise
*/
boolean isFolder();
/**
* Checks if the resource is internal.
*
* This state is stored as bit 1 in the resource flags.
*
* @return true if the resource is internal, otherwise false
*/
boolean isInternal();
/**
* Checks if the link has to be labeled with a special icon in the explorer view.
*
* This state is stored as bit 2 in the resource flags.
*
* @return true if a link to the resource has to be labeled, otherwise false
*/
boolean isLabeled();
/**
* Returns true if this resource is released at the given time according to the
* information stored in {@link #getDateReleased()}.
*
* @param time the time to check the release date against
*
* @return true if this resource is released at the given time
*
* @see #isExpired(long)
* @see #isReleasedAndNotExpired(long)
*/
boolean isReleased(long time);
/**
* Returns true if this resource is valid at the given time according to the
* information stored in {@link #getDateReleased()} and {@link #getDateExpired()}.
*
* A resource is valid if it is released and not yet expired.
*
* @param time the time to check the release and expiration date against
*
* @return true if this resource is valid at the given time
*
* @see #isExpired(long)
* @see #isReleased(long)
*/
boolean isReleasedAndNotExpired(long time);
/**
* Returns true if this resource was touched.
*
* @return boolean true if this resource was touched
*/
boolean isTouched();
}