Style Intelligence v12.0

inetsoft.sree
Class RepositoryEntry

java.lang.Object
  extended by inetsoft.sree.RepositoryEntry
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable, Comparable
Direct Known Subclasses:
ArchiveEntry, DefaultFolderEntry, RepletEntry, TrashcanEntry, ViewsheetEntry, WorksheetEntry

public class RepositoryEntry
extends Object
implements Serializable, Comparable, inetsoft.util.XMLSerializable

Represents an entry in the replet repository. An entry can be a folder, replet, or archived file.

See Also:
Serialized Form

Field Summary
static int ALL
          Flag indicating all types of entries.
static int ARCHIVE
          Flag indicating the entry is an archived report.
static int ARCHIVED_REPORTS
          Flag indicating the archived reports.
static int CHANGE_FOLDER_OPERATION
          Change folder operation.
static int COMPOSITE_ARCHIVE
          Flag indicating the entry is a composite archived report.
static int FILE
          Flag indicating the entry is a report file.
static int FOLDER
          Flag indicating the entry is a folder.
static int LIVE_REPORTS
          Flag indicating the live reports.
static String PROTOTYPE_FOLDER
          Prototype folder.
static int REMOVE_OPERATION
          Remove operation.
static int RENAME_OPERATION
          Rename operation.
static int REPLET
          Flag indicating the entry is a replet.
static String REPOSITORY_FOLDER
          Repository folder.
static int SNAPSHOTS
          Flag indicating the snapshots.
static int TRASHCAN
          Flag indicating the entry is a deleted folder or archive.
static String TRASHCAN_FOLDER
          Trashcan folder.
static int USER_FOLDERS
          Flag indicating the user folders.
static String USERS_FOLDER
          Users' folder.
static int VIEWSHEET
          Flag indicating the entry is a viewsheet.
static int VIEWSHEETS
          Flag indicating the viewsheets.
static int WORKSHEET
          Flag indicating the entry is a worksheet.
static int WORKSHEET_FOLDER
          Flag indicating the entry is a worksheet folder.
static int WORKSHEETS
          Flag indicating the worksheets.
 
Constructor Summary
RepositoryEntry()
          Constructor.
RepositoryEntry(String path, int type)
          Create a repository entry.
RepositoryEntry(String path, int type, String owner)
          Create a repository entry.
 
Method Summary
 int compareTo(Object obj)
          Compare to another object.
 boolean equals(Object obj)
          Check if equals another object.
 AssetEntry getAssetEntry()
          Get the asset entry.
 int getHtmlType()
          Get htmlType.
 String getLabel()
          Get the label of the repository entry.
 String getName()
          Get the name of the repository entry.
 String getOwner()
          Get the owner.
 RepositoryEntry getParent()
          Get the parent entry of the repository entry.
 String getParentPath()
          Get the parent path of the repository entry.
 String getPath()
          Get repository entry path.
 int getType()
          Get repository entry type, which should be one of the predefined types like FOLDER, REPLET, ARCHIVE, etc.
 int hashCode()
          Get the hash code value.
 boolean isArchive()
          Check if is an archive entry.
 boolean isFolder()
          Check if is a folder entry.
 boolean isMyReport()
          Check if is stored in my report folder or is my report folder.
 boolean isReplet()
          Check if is a replet entry.
 boolean isRoot()
          Check if is root.
 void parseAttributes(Element tag)
          Method to parse attributes.
 void parseContents(Element tag)
          Method to parse contents.
 void parseXML(Element tag)
          Method to parse an xml segment.
 void setHtmlType(int htmlType)
          Set htmlType.
 boolean supportsOperation(int operation)
          Check if supports an operation, which should be one of the predefined operation like RENAME_OPERATION, CHANGE_FOLDER_OPERATION, REMOVE_OPERATION, etc.
 String toString()
          Get the string representation.
 void writeAttributes(PrintWriter writer)
          Write attributes.
protected  void writeCDATA(PrintWriter writer, String name, String value)
          Write a name-value pair cdata representation to an output stream.
 void writeContents(PrintWriter writer)
          Write contents.
 void writeXML(PrintWriter writer)
          Write the xml segment to print writer.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

FOLDER

public static final int FOLDER
Flag indicating the entry is a folder.

See Also:
Constant Field Values

REPLET

public static final int REPLET
Flag indicating the entry is a replet.

See Also:
Constant Field Values

ARCHIVE

public static final int ARCHIVE
Flag indicating the entry is an archived report.

See Also:
Constant Field Values

COMPOSITE_ARCHIVE

public static final int COMPOSITE_ARCHIVE
Flag indicating the entry is a composite archived report.

See Also:
Constant Field Values

TRASHCAN

public static final int TRASHCAN
Flag indicating the entry is a deleted folder or archive.

See Also:
Constant Field Values

FILE

public static final int FILE
Flag indicating the entry is a report file.

See Also:
Constant Field Values

VIEWSHEET

public static final int VIEWSHEET
Flag indicating the entry is a viewsheet.

See Also:
Constant Field Values

WORKSHEET

public static final int WORKSHEET
Flag indicating the entry is a worksheet.

See Also:
Constant Field Values

WORKSHEET_FOLDER

public static final int WORKSHEET_FOLDER
Flag indicating the entry is a worksheet folder.

See Also:
Constant Field Values

ALL

public static final int ALL
Flag indicating all types of entries.

See Also:
Constant Field Values

RENAME_OPERATION

public static final int RENAME_OPERATION
Rename operation.

See Also:
Constant Field Values

CHANGE_FOLDER_OPERATION

public static final int CHANGE_FOLDER_OPERATION
Change folder operation.

See Also:
Constant Field Values

REMOVE_OPERATION

public static final int REMOVE_OPERATION
Remove operation.

See Also:
Constant Field Values

REPOSITORY_FOLDER

public static final String REPOSITORY_FOLDER
Repository folder.

See Also:
Constant Field Values

PROTOTYPE_FOLDER

public static final String PROTOTYPE_FOLDER
Prototype folder.

See Also:
Constant Field Values

TRASHCAN_FOLDER

public static final String TRASHCAN_FOLDER
Trashcan folder.

See Also:
Constant Field Values

USERS_FOLDER

public static final String USERS_FOLDER
Users' folder.

See Also:
Constant Field Values

USER_FOLDERS

public static final int USER_FOLDERS
Flag indicating the user folders.

See Also:
Constant Field Values

LIVE_REPORTS

public static final int LIVE_REPORTS
Flag indicating the live reports.

See Also:
Constant Field Values

SNAPSHOTS

public static final int SNAPSHOTS
Flag indicating the snapshots.

See Also:
Constant Field Values

ARCHIVED_REPORTS

public static final int ARCHIVED_REPORTS
Flag indicating the archived reports.

See Also:
Constant Field Values

VIEWSHEETS

public static final int VIEWSHEETS
Flag indicating the viewsheets.

See Also:
Constant Field Values

WORKSHEETS

public static final int WORKSHEETS
Flag indicating the worksheets.

See Also:
Constant Field Values
Constructor Detail

RepositoryEntry

public RepositoryEntry()
Constructor.


RepositoryEntry

public RepositoryEntry(String path,
                       int type)
Create a repository entry.

Parameters:
path - the specified path.
type - the specified entry type.

RepositoryEntry

public RepositoryEntry(String path,
                       int type,
                       String owner)
Create a repository entry.

Parameters:
path - the specified path.
type - the specified entry type.
owner - the specified owner.
Method Detail

supportsOperation

public boolean supportsOperation(int operation)
Check if supports an operation, which should be one of the predefined operation like RENAME_OPERATION, CHANGE_FOLDER_OPERATION, REMOVE_OPERATION, etc.

Parameters:
operation - the specified operation.
Returns:
true if supports the operation, false otherwise.

isRoot

public boolean isRoot()
Check if is root.

Returns:
true if is root, false otherwise.

getName

public String getName()
Get the name of the repository entry.

Returns:
the name of the repository entry.

getLabel

public String getLabel()
Get the label of the repository entry.

Returns:
the label of the repository entry.

getParent

public RepositoryEntry getParent()
Get the parent entry of the repository entry.

Returns:
the parent entry of the repository entry.

getParentPath

public String getParentPath()
Get the parent path of the repository entry.

Returns:
the parent path of the repository entry.

getPath

public String getPath()
Get repository entry path.

Returns:
repository entry path.

getType

public int getType()
Get repository entry type, which should be one of the predefined types like FOLDER, REPLET, ARCHIVE, etc.

Returns:
repository entry type.

isFolder

public boolean isFolder()
Check if is a folder entry.

Returns:
true if yes, false otherwise.

isReplet

public boolean isReplet()
Check if is a replet entry.

Returns:
true if yes, false otherwise.

isArchive

public boolean isArchive()
Check if is an archive entry.

Returns:
true if yes, false otherwise.

getOwner

public String getOwner()
Get the owner.

Returns:
the owner of this entry.

isMyReport

public boolean isMyReport()
Check if is stored in my report folder or is my report folder.

Returns:
true if yes, false otherwise.

writeXML

public void writeXML(PrintWriter writer)
Write the xml segment to print writer.

Specified by:
writeXML in interface inetsoft.util.XMLSerializable
Parameters:
writer - the destination print writer.

parseXML

public void parseXML(Element tag)
              throws Exception
Method to parse an xml segment.

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Throws:
Exception

writeAttributes

public void writeAttributes(PrintWriter writer)
Write attributes.

Parameters:
writer - the destination print writer.

parseAttributes

public void parseAttributes(Element tag)
                     throws Exception
Method to parse attributes.

Throws:
Exception

writeContents

public void writeContents(PrintWriter writer)
Write contents.

Parameters:
writer - the destination print writer.

parseContents

public void parseContents(Element tag)
                   throws Exception
Method to parse contents.

Throws:
Exception

toString

public String toString()
Get the string representation.

Overrides:
toString in class Object
Returns:
the string representation.

hashCode

public int hashCode()
Get the hash code value.

Overrides:
hashCode in class Object
Returns:
the hash code value.

equals

public boolean equals(Object obj)
Check if equals another object.

Overrides:
equals in class Object
Parameters:
obj - the specified object.
Returns:
true if equals another object, false otherwise.

compareTo

public int compareTo(Object obj)
Compare to another object.

Specified by:
compareTo in interface Comparable
Parameters:
obj - the specified object.
Returns:
compare result.

getAssetEntry

public AssetEntry getAssetEntry()
Get the asset entry.


writeCDATA

protected void writeCDATA(PrintWriter writer,
                          String name,
                          String value)
Write a name-value pair cdata representation to an output stream.

Parameters:
writer - the specified output stream.
name - the specified name.
value - the specified value.

setHtmlType

public void setHtmlType(int htmlType)
Set htmlType.


getHtmlType

public int getHtmlType()
Get htmlType.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.