org.pentaho.platform.api.repository2.unified
Class RepositoryFile

java.lang.Object
  extended by org.pentaho.platform.api.repository2.unified.RepositoryFile
All Implemented Interfaces:
Serializable, Comparable<RepositoryFile>

public class RepositoryFile
extends Object
implements Comparable<RepositoryFile>, Serializable

Immutable repository file. Use the RepositoryFile.Builder to create instances.

This class should use only GWT-emulated types.

Author:
mlowery
See Also:
Serialized Form

Nested Class Summary
static class RepositoryFile.Builder
           
 
Field Summary
static String ROOT_LOCALE
          Key used in titleMap or descriptionMap that indicates what string to use when no locale information is available.
static String SEPARATOR
           
 
Constructor Summary
RepositoryFile(Serializable id, String name)
           
RepositoryFile(String name)
           
 
Method Summary
 int compareTo(RepositoryFile other)
           
 boolean equals(Object obj)
           
 Date getCreatedDate()
           
 Date getDeletedDate()
           
 String getDescription()
           
 Map<String,String> getDescriptionMap()
           
 Serializable getId()
           
 Date getLastModifiedDate()
           
 String getLocale()
           
 Date getLockDate()
           
 String getLockMessage()
           
 String getLockOwner()
           
 String getName()
           
 Serializable getOriginalParentFolderId()
           
 String getOriginalParentFolderPath()
           
 RepositoryFileSid getOwner()
           
 String getPath()
           
 String getTitle()
          Returns title for current locale or file name if not available.
 Map<String,String> getTitleMap()
           
 Serializable getVersionId()
           
 int hashCode()
           
 boolean isFolder()
           
 boolean isHidden()
           
 boolean isLocked()
           
 boolean isVersioned()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SEPARATOR

public static final String SEPARATOR
See Also:
Constant Field Values

ROOT_LOCALE

public static final String ROOT_LOCALE
Key used in titleMap or descriptionMap that indicates what string to use when no locale information is available.

See Also:
Constant Field Values
Constructor Detail

RepositoryFile

public RepositoryFile(String name)

RepositoryFile

public RepositoryFile(Serializable id,
                      String name)
Method Detail

getName

public String getName()

getId

public Serializable getId()

getCreatedDate

public Date getCreatedDate()

getLastModifiedDate

public Date getLastModifiedDate()

isFolder

public boolean isFolder()

getPath

public String getPath()

isHidden

public boolean isHidden()

isVersioned

public boolean isVersioned()

getVersionId

public Serializable getVersionId()

isLocked

public boolean isLocked()

getLockOwner

public String getLockOwner()

getLockMessage

public String getLockMessage()

getLockDate

public Date getLockDate()

getOwner

public RepositoryFileSid getOwner()

getTitle

public String getTitle()
Returns title for current locale or file name if not available.


getDescription

public String getDescription()

getTitleMap

public Map<String,String> getTitleMap()

getDescriptionMap

public Map<String,String> getDescriptionMap()

getLocale

public String getLocale()

getOriginalParentFolderPath

public String getOriginalParentFolderPath()

getOriginalParentFolderId

public Serializable getOriginalParentFolderId()

getDeletedDate

public Date getDeletedDate()

toString

public String toString()
Overrides:
toString in class Object

compareTo

public int compareTo(RepositoryFile other)
Specified by:
compareTo in interface Comparable<RepositoryFile>

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object