lumis.portal.filesystem

Interface IPortalBaseFolder

All Superinterfaces:

Serializable

All Known Subinterfaces:

IWebRootPortalBaseFolder

All Known Implementing Classes:

AbstractPortalBaseFolder, PortalBaseFolder

@StableMinor(version="7.1",
             sinceVersion="6.2")
public interface IPortalBaseFolder
extends Serializable

A portal base folder represents a logical folder known to the portal. It provides operations to convert between relative (logical) and absolute (real) paths for resource inside the structure represented by it.

A portal base folder implementation must be serializable in such way that after being transferred between Lumis Portal instances, it resolves to the equivalent files in the new instance.

Since:

6.2.0

Version:

$Revision: 16039 $ $Date: 2013-11-21 21:33:39 -0200 (Thu, 21 Nov 2013) $

See Also:

PortalFile, PortalFilePath, PortalBaseFolder, IWebsite.getWebRootBaseFolder()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether this base folder is equivalent to the given base folder.
String	getAbsolutePath(String relativePath) Calculates the absolute path from a relative path to this base folder.
String	getRelativePath(String absolutePath) Calculates the relative path to this base folder for the given absolute path.
String	toString() A string for display purposes that identifies this base folder.

Method Detail

getAbsolutePath

String getAbsolutePath(String relativePath)

Calculates the absolute path from a relative path to this base folder.

Parameters:

relativePath - the relative path.

Returns:

the absolute path.

Since:

6.2.0

getRelativePath

String getRelativePath(String absolutePath)

Calculates the relative path to this base folder for the given absolute path.

Parameters:

absolutePath - the absolute path.

Returns:

the calculated relative path, relative to this base folder.

Throws:

IllegalArgumentException - if the given absolute path is invalid or does not belongs to this base folder area.

Since:

6.2.0

equals

boolean equals(Object obj)

Indicates whether this base folder is equivalent to the given base folder.

Equivalent base folders represent the same real folder and semantics. Two equivalent base folders have the same results on its conversions between absolute and relative paths. But it is possible to two base folders to resolve its conversions the same way, but not be considered equivalent, if they do not share the same semantics.

Overrides:

equals in class Object

Parameters:

obj - the object to compare to.

Returns:

true if this base folder is equivalent to a given base folder; false otherwise.

Since:

6.2.0

toString

String toString()

A string for display purposes that identifies this base folder.

In special, PortalFilePath uses this string to create its own toString, in the form: [base folder]:/[relative path]. This method should return a value that keeps that form friendly.

Overrides:

toString in class Object

Returns:

a string representation of this base folder.

Since:

6.2.0