com.docdoku.core.meta

Class Folder

java.lang.Object

com.docdoku.core.meta.Folder

All Implemented Interfaces:

Serializable, Comparable<Folder>

@Entity
public class Folder
extends Object
implements Serializable, Comparable<Folder>

The Folder class is a unitary element of a tree structure. Like in a regular file system, folder may contain other folders. Folder is a way to organize entities like Tag could be.

Since:

V1.0

Version:

1.0, 02/06/08

Author:

Florent Garin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Folder()
Folder(String pCompletePath)
Folder(String pParentFolderPath, String pShortName)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Folder pFolder)
static Folder	createHomeFolder(String pWorkspaceId, String pLogin)
static Folder	createRootFolder(String pWorkspaceId)
Folder	createSubFolder(String pShortName)
boolean	equals(Object pObj)
Folder[]	getAllFolders()
String	getCompletePath()
String	getOwner()
Folder	getParentFolder()
String	getRoutePath()
String	getShortName()
String	getWorkspaceId()
int	hashCode()
boolean	isHome()
boolean	isPrivate()
boolean	isRoot()
static String	parseWorkspaceId(String pCompletePath)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Folder

public Folder()

Folder

public Folder(String pCompletePath)

Folder

public Folder(String pParentFolderPath,
              String pShortName)

Method Detail

getWorkspaceId

public String getWorkspaceId()

parseWorkspaceId

public static String parseWorkspaceId(String pCompletePath)

isRoot

public boolean isRoot()

isHome

public boolean isHome()

isPrivate

public boolean isPrivate()

getOwner

public String getOwner()

toString

public String toString()

Overrides:

toString in class Object

getCompletePath

public String getCompletePath()

getParentFolder

public Folder getParentFolder()

getAllFolders

public Folder[] getAllFolders()

getShortName

public String getShortName()

getRoutePath

public String getRoutePath()

createRootFolder

public static Folder createRootFolder(String pWorkspaceId)

createHomeFolder

public static Folder createHomeFolder(String pWorkspaceId,
                                      String pLogin)

createSubFolder

public Folder createSubFolder(String pShortName)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object pObj)

Overrides:

equals in class Object

compareTo

public int compareTo(Folder pFolder)

Specified by:

compareTo in interface Comparable<Folder>