nl.hippo.client.api.content
Interface DocumentPath

All Superinterfaces:

Serializable

public interface DocumentPath
extends Serializable

Represents a path in the repository.

methods

• getNamespace() => returns hippo.client.namespace from WebdavConfig
• getFilesPath() => returns hippo.client.filespath from WebdavConfig
• getRootPath() => returns getNameSpace() + getFilesPath()
• getRelativePath() => returns the relative documentpath (getFullPath() - getRootPath())
• getFullPath() => returns getRootPath() + getRelativePath()

slashes

• getNamespace() -> without any slashes
• All other methods -> starts with slash and ends without slash

These rules are guaranteed even if the configuration isn't completely clean, ie "namespace = /default/"

Method Summary

DocumentPath	createAbsolutePath(String absolute)
DocumentPath	createAbsolutePath(String[] pathElems)
DocumentPath	createRelativePath(String relative)
DocumentPath	createRelativePath(String[] pathElems)
String	getContextRoot() returns hippo.client.contextroot
String	getFilesPath() returns hippo.client.filespath
String	getFullPath() returns getRootPath() + getRelativePath()
String	getNamespace() returns hippo.client.namespace
String	getRelativePath() returns the relative documentpath
String	getRootPath() returns getNameSpace() + getFilesPath()

Method Detail

getContextRoot

String getContextRoot()

returns hippo.client.contextroot

getNamespace

String getNamespace()

returns hippo.client.namespace

getFilesPath

String getFilesPath()

returns hippo.client.filespath

getRootPath

String getRootPath()

returns getNameSpace() + getFilesPath()

getRelativePath

String getRelativePath()

returns the relative documentpath

getFullPath

String getFullPath()

returns getRootPath() + getRelativePath()

createRelativePath

DocumentPath createRelativePath(String[] pathElems)

Parameters:

pathElems - A String array of path elements, will be concatenated and appended to the root path

Returns:

A new DocumentPath

createRelativePath

DocumentPath createRelativePath(String relative)

Parameters:

relative - path string, will be appended to the root path

Returns:

A new DocumentPath

createAbsolutePath

DocumentPath createAbsolutePath(String absolute)

Parameters:

absolute - path string

Returns:

A new DocumentPath

Throws:

IllegalArgumentException - if param absolute doesn't start with rootpath

createAbsolutePath

DocumentPath createAbsolutePath(String[] pathElems)

Parameters:

pathElems - A String array of path elements, will be concatenated

Returns:

A new DocumentPath

Throws:

IllegalArgumentException - if the concatenated String[] doesn't start with rootpath