lumis.portal.filesystem

Class AbstractPortalBaseFolder

java.lang.Object

lumis.portal.filesystem.AbstractPortalBaseFolder

All Implemented Interfaces:

Serializable, IPortalBaseFolder

public abstract class AbstractPortalBaseFolder
extends Object
implements IPortalBaseFolder

Abstract IPortalBaseFolder implementation, used as base class for some implementations.

This implementation assumes the base folder corresponds to a folder in the local file system. The concrete implementation decides the local folder to be used by implementing calculateBasePath().

Since:

6.2.0

Version:

$Revision: 22420 $ $Date: 2019-02-19 19:21:02 +0000 (Tue, 19 Feb 2019) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractPortalBaseFolder()

Method Summary

Modifier and Type	Method and Description
protected abstract String	calculateBasePath() Calculates the absolute path for this base folder.
String	getAbsolutePath(String relativePath) Calculates the absolute path from a relative path to this base folder.
String	getBasePath() Returns the path that corresponds 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface lumis.portal.filesystem.IPortalBaseFolder

equals

Constructor Detail

AbstractPortalBaseFolder

public AbstractPortalBaseFolder()

Method Detail

getBasePath

public final String getBasePath()

Returns the path that corresponds to this base folder.

Returns:

the file system path to be used as reference to this web root base folder.

Since:

6.2.0

calculateBasePath

protected abstract String calculateBasePath()

Calculates the absolute path for this base folder.

Called by getBasePath(). Its result stored and reused automatically.

Returns:

the absolute path for this base folder.

Since:

6.2.0

getAbsolutePath

public String getAbsolutePath(String relativePath)

Description copied from interface: IPortalBaseFolder

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

Specified by:

getAbsolutePath in interface IPortalBaseFolder

Parameters:

relativePath - the relative path.

Returns:

the absolute path.

getRelativePath

public String getRelativePath(String absolutePath)

Description copied from interface: IPortalBaseFolder

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

Specified by:

getRelativePath in interface IPortalBaseFolder

Parameters:

absolutePath - the absolute path.

Returns:

the calculated relative path, relative to this base folder.

toString

public String toString()

Description copied from interface: IPortalBaseFolder

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.

Specified by:

toString in interface IPortalBaseFolder

Overrides:

toString in class Object

Returns:

a string representation of this base folder.