oracle.ifs.beans

Class FolderPathResolver

java.lang.Object

oracle.ifs.beans.FolderPathResolver

All Implemented Interfaces:

Cloneable

public final class FolderPathResolver
extends Object
implements Cloneable

The FolderPathResolver class is used for tracking the current directory while navigating around in a folder tree. It can also be used for finding PublicObjects in a folder tree hierarchy.

It is able to find a PublicObject using the absolute path or a relative path. It understands wildcards, folder delimiters, and illegal characters within an absolute path.

For ease in folder navigation, one can set the "root" and "home" folders.

Version:

1.0

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_DIRECTORY_TOKEN The "current directory" token.
static String	FOLDER_DELIMITER The default folder path delimiter.
protected Folder	m_CurrentDirectory The Folder representing the current directory
protected String	m_CurrentPath The String representing the current directory.
protected String	m_Delim used to maintain the path Strings as up-to-date as possible costs one string compare
protected boolean	m_IsRootTopDirectory Is the Root Folder the top directory?
protected IfsObjectResolver	m_LookupResolver the lookup handler
protected Folder	m_RootFolder The Folder representing the root directory.
protected LibrarySession	m_Session The current session
protected Folder	m_TopDirectory The Folder representing the top directory
protected String	m_TopPath The String representing the top directory.
static char	MATCH_ALL The character used as the wildcard to match any (0 or more) characters.
static char	MATCH_ONE The character used as the wildcard to match any single character.
protected static char[]	s_IllegalCharacterSet illegal filename chars and legal delimiter chars
protected static char[]	s_LegalDelimiters legal delimiters
static String	UP_DIRECTORY_TOKEN The "change directory UP one level" token.

Constructor Summary

Constructors

Constructor and Description
FolderPathResolver(LibrarySession session) default constructor.

Method Summary

Modifier and Type	Method and Description
static void	assertLegalDelimiter(String delimiter) checks to make sure delimiter is a legal delimitier
static boolean	containsWildcard(String s) Checks whether folder path contains any wildcards.
static String	exchangeDelimiters(String path, String oldDelim, String newDelim) used to adapt paths to a change in the LibrarySession.getFolderPathDelimiter
static PublicObject[]	filterItems(PublicObject[] pos, String match) Performs wildcard filtering of Folder.getItems() wildcard matching
PublicObject	findPublicObjectByPath(String path) Returns the PublicObject for which the path specifies.
String	getAbsolutePath(String relativePath) Gets the absolute path from a realtive path
Folder	getCurrentDirectory() Get the current directory in effect.
protected static String	getCurrentLocationEmbedded(String delim) defaults to "/
protected static String	getCurrentLocationPrefix(String delim) defaults to "
String	getCurrentPath() Get the current file path in effect.
static char[]	getIllegalPathCharacters() Get the illegal path characters.
static char[]	getLegalPathDelimiters() Get the legal path delimiters.
Folder	getTopDirectory() Get the top directory in effect.
String	getTopPath() Get the top file path in effect.
static boolean	isLegalDelimiter(String delimiter) checks to make sure delimiter is a legal delimitier
void	setCurrentDirectory(Folder folder) Sets the current path to the specified Folder's path
void	setHomeFolder() Change current folder to a home folder for the current user.
void	setHomeFolder(DirectoryUser user) Set current folder to the home folder of a specified directory user
void	setHomeFolder(String username) Change current folder to a home folder for a specified user.
void	setHomeFolder(String username, String anonymousUsername, boolean robust) Change current folder to a home folder for a specified user.
void	setRelativePath(String path) Change current folder to relative path
void	setRootFolder() Change current folder to the Root Folder
void	setRootFolder(Folder root) Change current folder to the Root Folder

Methods inherited from class java.lang.Object

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

Field Detail

s_IllegalCharacterSet

protected static final char[] s_IllegalCharacterSet

illegal filename chars and legal delimiter chars

(Unpublished)

s_LegalDelimiters

protected static final char[] s_LegalDelimiters

legal delimiters

(Unpublished)

UP_DIRECTORY_TOKEN

public static final String UP_DIRECTORY_TOKEN

The "change directory UP one level" token.

See Also:

Constant Field Values

(Published)

CURRENT_DIRECTORY_TOKEN

public static final String CURRENT_DIRECTORY_TOKEN

The "current directory" token.

See Also:

Constant Field Values

(Published)

FOLDER_DELIMITER

public static final String FOLDER_DELIMITER

The default folder path delimiter.

See Also:

Constant Field Values

(Published)

MATCH_ALL

public static final char MATCH_ALL

The character used as the wildcard to match any (0 or more) characters.

See Also:

Constant Field Values

(Published)

MATCH_ONE

public static final char MATCH_ONE

The character used as the wildcard to match any single character.

See Also:

Constant Field Values

(Published)

m_Delim

protected String m_Delim

used to maintain the path Strings as up-to-date as possible costs one string compare

(Unpublished)

m_Session

protected LibrarySession m_Session

The current session

(Unpublished)

m_LookupResolver

protected IfsObjectResolver m_LookupResolver

the lookup handler

(Unpublished)

m_CurrentPath

protected String m_CurrentPath

The String representing the current directory.

(Unpublished)

m_TopPath

protected String m_TopPath

The String representing the top directory.

(Unpublished)

m_RootFolder

protected Folder m_RootFolder

The Folder representing the root directory.

(Unpublished)

m_CurrentDirectory

protected Folder m_CurrentDirectory

The Folder representing the current directory

(Unpublished)

m_TopDirectory

protected Folder m_TopDirectory

The Folder representing the top directory

(Unpublished)

m_IsRootTopDirectory

protected boolean m_IsRootTopDirectory

Is the Root Folder the top directory?

(Unpublished)

Constructor Detail

FolderPathResolver

public FolderPathResolver(LibrarySession session)
                   throws IfsException

default constructor.

Parameters:

session - LibrarySession the session

Throws:

IfsException - if operation fails.

(Published)

Method Detail

getIllegalPathCharacters

public static char[] getIllegalPathCharacters()

Get the illegal path characters. This currently returns: {'\\', '/', ':', '*', '?', '"', '<', '>', '|'}

Returns:

an array of the illegal path characters

(Published)

getLegalPathDelimiters

public static char[] getLegalPathDelimiters()

Get the legal path delimiters.

Returns:

an array of the legal path delimiters

(Published)

getCurrentPath

public String getCurrentPath()
                      throws IfsException

Get the current file path in effect.

Returns:

the current file path

Throws:

IfsException - if operation fails.

(Published)

getTopPath

public String getTopPath()
                  throws IfsException

Get the top file path in effect.

Returns:

the top file path

Throws:

IfsException - if operation fails.

(Published)

getCurrentDirectory

public Folder getCurrentDirectory()
                           throws IfsException

Get the current directory in effect.

Returns:

the current directory Folder object

Throws:

IfsException - if operation fails.

(Published)

getTopDirectory

public Folder getTopDirectory()
                       throws IfsException

Get the top directory in effect.

Returns:

the top directory Folder object

Throws:

IfsException - if operation fails.

(Published)

setRootFolder

public void setRootFolder()
                   throws IfsException

Change current folder to the Root Folder

Throws:

IfsException - if operation fails.

(Published)

setRootFolder

public void setRootFolder(Folder root)
                   throws IfsException

Change current folder to the Root Folder

Parameters:

root - Folder that acts as the root

Throws:

IfsException - if operation fails.

(Published)

setHomeFolder

public void setHomeFolder()
                   throws IfsException

Change current folder to a home folder for the current user.

Throws:

IfsException - if operation fails.

(Published)

setHomeFolder

public void setHomeFolder(String username)
                   throws IfsException

Change current folder to a home folder for a specified user.

Throws:

IfsException - if operation fails.

(Published)

setHomeFolder

public void setHomeFolder(DirectoryUser user)
                   throws IfsException

Set current folder to the home folder of a specified directory user

Throws:

IfsException - if operation fails.

(Published)

setHomeFolder

public void setHomeFolder(String username,
                          String anonymousUsername,
                          boolean robust)
                   throws IfsException

Change current folder to a home folder for a specified user. if robust then: 1. the user's home folder, provided that there's a reachable path to it and the user isn't anonymous. 2. if none, set to the Folder referenced by the ValueDefault IFS.REPOS.InitialAnonymousFolder 3. If none, set to the anonymousUsername user's home folder 4. if none, set to the root folder

Throws:

IfsException - if operation fails.

(Published)

setCurrentDirectory

public void setCurrentDirectory(Folder folder)
                         throws IfsException

Sets the current path to the specified Folder's path

Throws:

IfsException - if operation fails.

(Published)

getAbsolutePath

public String getAbsolutePath(String relativePath)
                       throws IfsException

Gets the absolute path from a realtive path

Parameters:

relativePath - can be absolute

Throws:

IfsException

(Published)

setRelativePath

public void setRelativePath(String path)
                     throws IfsException

Change current folder to relative path

Throws:

IfsException - if operation fails.

(Published)

findPublicObjectByPath

public PublicObject findPublicObjectByPath(String path)
                                    throws IfsException

Returns the PublicObject for which the path specifies. If the path ends in the folderpath delimiter then the PublicObject is a Folder or FolderLink.

Returns:

the PublicObject for which the path specifies.

Throws:

IfsException - if operation fails.

(Published)

containsWildcard

public static boolean containsWildcard(String s)
                                throws IfsException

Checks whether folder path contains any wildcards.

Returns:

TRUE if any wildcards are found

Throws:

IfsException

(Published)

filterItems

public static PublicObject[] filterItems(PublicObject[] pos,
                                         String match)
                                  throws IfsException

Performs wildcard filtering of Folder.getItems() wildcard matching

Parameters:

pos - PublicObjects the objects to filter through

match - the wildcard string to match

Returns:

the PublicObjects which pass through the wildcard filter.

Throws:

IfsException

(Unpublished)

exchangeDelimiters

public static String exchangeDelimiters(String path,
                                        String oldDelim,
                                        String newDelim)

used to adapt paths to a change in the LibrarySession.getFolderPathDelimiter

(Unpublished)

getCurrentLocationPrefix

protected static String getCurrentLocationPrefix(String delim)

defaults to "./"

(Unpublished)

getCurrentLocationEmbedded

protected static String getCurrentLocationEmbedded(String delim)

defaults to "/./"

(Unpublished)

assertLegalDelimiter

public static void assertLegalDelimiter(String delimiter)
                                 throws IfsException

checks to make sure delimiter is a legal delimitier

Throws:

IfsException - if delimiter is not legal

(Unpublished)

isLegalDelimiter

public static boolean isLegalDelimiter(String delimiter)
                                throws IfsException

checks to make sure delimiter is a legal delimitier

Throws:

if - operation fails

IfsException

(Unpublished)