Style Intelligence v12.0

inetsoft.uql.asset
Class AssetEntry

java.lang.Object
  extended by inetsoft.uql.asset.AssetEntry
All Implemented Interfaces:
AssetObject, inetsoft.util.DataSerializable, inetsoft.util.XMLSerializable, Serializable, Cloneable, Comparable

public class AssetEntry
extends Object
implements AssetObject, Comparable, inetsoft.util.DataSerializable

AssetEntry locates a sheet or folder in AssetRepository. For a user scope sheet/folder, the associated user is required, and for a report scope sheet/folder, the associated report id stored as the property REPORT_ID is required.

See Also:
Serialized Form

Field Summary
static int BEAN
          Bean entry.
static int BEAN_FOLDER
          Bean folder entry.
static int COLUMN
          Column entry.
static int COMPONENT
          Component entry.
static String CUBE
          Cube query type.
static String CUBE_COL_TYPE
          Cube column type.
static String CURRENT_QUERY
          Current query.
static int DATA
          Data entry.
static int DATA_MODEL
          Data Model entry.
static int DATA_SOURCE
          Data source entry.
static int DATA_SOURCE_FOLDER
          Datasource folder entry.
static String DATA_SOURCE_TYPE
          Datasource type.
static int DATE_DIMENSIONS
          Cube column is date dimension.
static int DIMENSIONS
          Cube column is dimension.
static int EMBEDDED_PS_FOLDER
          Local Worksheet folder entry.
static int ERM
          All erm entries.
static int EXTENDED_LOGIC_MODEL
          Extended Logic model entry.
static int EXTENDED_MODEL
          Physical model partition entry.
static int EXTENDED_PARTITION
          Extended physical model partition entry.
static int FOLDER
          Folder entry.
static int LOCAL_QUERY_FOLDER
          Local Query folder entry.
static int LOGIC_MODEL
          Logic model.
static int MEASURES
          Cube column is measure.
static int META_TEMPLATE
          Meta template entry.
static int META_TEMPLATE_FOLDER
          Meta template folder entry.
static String NORMAL
          Normal query type.
static int PARAMETER_SHEET
          Parameter sheet entry.
static int PARAMETER_SHEET_FOLDER
          Parameter sheet folder entry.
static int PARTITION
          Physical model partition entry.
static String PATH_ARRAY
          Path array.
static int PHYSICAL
          Physical entry.
static int PHYSICAL_COLUMN
          Physical column.
static int PHYSICAL_FOLDER
          Physical folder.
static int PHYSICAL_TABLE
          Physical table.
static String PRE_AGGREGATE
          Pre-aggregate query type.
static int QUERY
          Query entry.
static int QUERY_FOLDER
          Query folder entry.
static String QUERY_TYPE
          Query type.
static int REPLET
          Report
static int REPORT_COMPONENT
          Report component type.
static String REPORT_DATA_SOURCE
          Report data source.
static String REPORT_ID
          Report id property.
static int REPORT_WORKSHEET_FOLDER
          Local Worksheet folder entry.
static int REPOSITORY_FOLDER
          Repository folder.
static int SCRIPT
          Script entry.
static int SCRIPT_FOLDER
          Table style sub folder entry.
static int SHAPE
          Shape entry.
static String SHEET_DESCRIPTION
          Worksheet description.
static int TABLE
          Table entry.
static int TABLE_STYLE
          Table style entry.
static int TABLE_STYLE_FOLDER
          Table style folder entry.
static int UNKNOWN
          Unknown entry.
static int VARIABLE
          Vairable entry.
static int VIEWSHEET
          Viewsheet entry.
static int VIEWSHEET_BOOKMARK
          Bookmark entry.
static int VIEWSHEET_SNAPSHOT
          Snapshot entry.
static int VPM
          Virtual private model entry.
static int WORKSHEET
          Worksheet entry.
static String WORKSHEET_TYPE
          Worksheet type.
 
Constructor Summary
AssetEntry()
          Constructor.
AssetEntry(int scope, int type, String path, String user)
          Constructor.
 
Method Summary
 Object clone()
          Clone the object.
 int compareTo(Object obj)
          Compare to another object.
 void copyProperties(AssetEntry entry)
          Copy properties from another asset entry.
static AssetEntry createAssetEntry(Element elem)
          Create an asset entry from an xml element.
static AssetEntry createAssetEntry(String identifier)
          Create an asset entry from a string identifier.
static AssetEntry createGlobalRoot()
          Create the root entry for the global scope.
static AssetEntry createReportRoot()
          Create the root entry for the report scope.
static AssetEntry createUserRoot(Principal user)
          Create the root entry for the user scope.
 boolean equals(Object obj)
          Check if equals another object.
 String getAlias()
          Get a alias of the asset entry.
 Date getCreatedDate()
          Get the created date
 String getCreatedUsername()
          Get the created username
 String getDependencyPattern()
          Get the dependecy pattern.
static String getDependencyPrefix()
          Get the dependecy prefix.
 String getDescription()
          Get the description without localization.
 String getDescription(boolean localize)
          Get the description without localization.
 String getDescription(boolean localize, boolean isAsset)
          Get the description without localization.
 String getLockPath()
          Get the lock path of the asset entry.
 Date getModifiedDate()
          Get the modified date
 String getModifiedUsername()
          Get the modified username
 String getName()
          Get the name of the asset entry.
 AssetEntry getParent()
          Get the parent entry of the asset entry.
 String getParentPath()
          Get the parent path of the asset entry.
 String getPath()
          Get the path of the asset entry.
 String getProperty(String key)
          Get a property of the asset entry.
 Enumeration getPropertyKeys()
          Get the keys of the properties.
 int getScope()
          Get the scope of the asset entry, which should be one of the predefined types in AssetRepository like GLOBAL_SCOPE, USER_SCOPE, etc.
 String getSheetName()
          If the entry is sheet, get fullpath and scope as the sheet name.
 int getType()
          Get the type of the asset entry, which should be one of the predefined types like FOLDER, WORKSHEET, etc.
 String getUser()
          Get the user of the asset entry.
 int hashCode()
          Get the hash code value.
 boolean isActualFolder()
           
 boolean isAncestor(AssetEntry entry)
          Check if is the ancestor of another entry.
 boolean isBean()
          Check if is a bean entry.
 boolean isBeanFolder()
          Check if is a bean folder entry.
 boolean isColumn()
          Check if is a column entry.
 boolean isData()
          Check if is a data entry.
 boolean isDataModel()
          Check if is a data model entry.
 boolean isDataSource()
          Check if is a data source entry.
 boolean isDataSourceFolder()
          Check if is a data source folder entry.
 boolean isEditable()
          Check if is editable.
 boolean isEmbeddedParameterSheet()
          Check if is an embedded parameter sheet entry.
 boolean isEmbeddedPSFolder()
          Check if is a local parameter sheet folder entry.
 boolean isExtendedLogicModel()
          Check if is a extended logic model entry.
 boolean isExtendedModel()
          Check if is a extended model entry.
 boolean isExtendedPartition()
          Check if is a extended partion entry.
 boolean isFolder()
          Check if is a folder entry.
static boolean isIgnoredProperty(String key)
          Check if is an ignored property.
 boolean isLocalQuery()
          Check if is a local query folder entry.
 boolean isLocalQueryFolder()
          Check if is a local query folder entry.
 boolean isLocalWorksheet()
          Check if is a local worksheet entry.
 boolean isLogicModel()
          Check if is a logic model entry.
 boolean isMetaTemplate()
          Check if is a meta template entry.
 boolean isMetaTemplateFolder()
          Check if is a meta template folder entry.
 boolean isMyReportsFolder()
          Check if is the My Reports folder entry.
 boolean isParameterSheet()
          Check if is a parameter sheet entry.
 boolean isParameterSheetFolder()
          Check if is a parameter sheet folder entry.
 boolean isPartition()
          Check if is a partion entry.
 boolean isPhysicalFolder()
          Check if is a physical folder entry.
 boolean isPhysicalTable()
          Check if is a physical table entry.
 boolean isQuery()
          Check if is a query entry.
 boolean isQueryFolder()
          Check if is a query folder entry.
 boolean isReplet()
          Check if is a replet entry.
 boolean isReportDataSource()
          Check if is treated as a report data source.
 boolean isReportWorksheetFolder()
          Check if is a local worksheet folder entry.
 boolean isRepositoryFolder()
          Check if is a repository folder entry.
 boolean isRoot()
          Check if is root.
 boolean isScript()
          Check if is a script function entry.
 boolean isScriptFolder()
          Check if is a script folder entry.
 boolean isSheet()
          Check if is a sheet entry.
 boolean isTable()
          Check if is a table entry.
 boolean isTableStyle()
          Check if is a table style entry.
 boolean isTableStyleFolder()
          Check if is a table style folder entry.
 boolean isTableStyleSubFolder()
          Check if is a table style sub folder entry.
 boolean isValid()
          Check if the asset entry is valid.
 boolean isVariable()
          Check if is a variable entry.
 boolean isViewsheet()
          Check if is a viewsheet entry.
 boolean isVPM()
          Check if is a vpm entry.
 boolean isVSSnapshot()
          Check if is a viewsheet snapshot entry.
 boolean isWorksheet()
          Check if is a worksheet entry.
 boolean isWorksheetFolder()
          Check if is a worksheet folder entry.
 boolean parseData(DataInputStream input)
          Parse data from an InputStream.
 void parseXML(Element elem)
          Method to parse an xml segment.
 void resetMVOptions()
          Reset mv options.
 void setAlias(String alias)
          Set a alias of the asset entry.
 void setCreatedDate(Date createdDate)
          Set the created date
 void setCreatedUsername(String createdUsername)
          Set the created username
 void setModifiedDate(Date modifiedDate)
          Set the modified date
 void setModifiedUsername(String modifiedUsername)
          Set modified username
 void setProperty(String key, String value)
          Set a property of the asset entry.
 void setReportDataSource(boolean source)
          Set whether is treated as a report data source.
 String toDescription()
          Get the description for debug only.
 String toIdentifier()
          To string identifier.
 String toString()
          Get the string representation.
 String toView()
          Get the string to display.
 void writeData(DataOutputStream dos)
          Write data to a DataOutputStream.
 void writeProperties2(DataOutputStream dos)
          Write properties.
 void writeXML(PrintWriter writer)
          Write the xml segment to print writer.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

UNKNOWN

public static final int UNKNOWN
Unknown entry.

See Also:
Constant Field Values

FOLDER

public static final int FOLDER
Folder entry.

See Also:
Constant Field Values

WORKSHEET

public static final int WORKSHEET
Worksheet entry.

See Also:
Constant Field Values

DATA

public static final int DATA
Data entry.

See Also:
Constant Field Values

COLUMN

public static final int COLUMN
Column entry.

See Also:
Constant Field Values

TABLE

public static final int TABLE
Table entry.

See Also:
Constant Field Values

QUERY

public static final int QUERY
Query entry.

See Also:
Constant Field Values

LOGIC_MODEL

public static final int LOGIC_MODEL
Logic model.

See Also:
Constant Field Values

DATA_SOURCE

public static final int DATA_SOURCE
Data source entry.

See Also:
Constant Field Values

VIEWSHEET

public static final int VIEWSHEET
Viewsheet entry.

See Also:
Constant Field Values

PHYSICAL

public static final int PHYSICAL
Physical entry.

See Also:
Constant Field Values

PHYSICAL_FOLDER

public static final int PHYSICAL_FOLDER
Physical folder.

See Also:
Constant Field Values

PHYSICAL_TABLE

public static final int PHYSICAL_TABLE
Physical table.

See Also:
Constant Field Values

PHYSICAL_COLUMN

public static final int PHYSICAL_COLUMN
Physical column.

See Also:
Constant Field Values

COMPONENT

public static final int COMPONENT
Component entry.

See Also:
Constant Field Values

SHAPE

public static final int SHAPE
Shape entry.

See Also:
Constant Field Values

REPOSITORY_FOLDER

public static final int REPOSITORY_FOLDER
Repository folder.

See Also:
Constant Field Values

VIEWSHEET_SNAPSHOT

public static final int VIEWSHEET_SNAPSHOT
Snapshot entry.

See Also:
Constant Field Values

VIEWSHEET_BOOKMARK

public static final int VIEWSHEET_BOOKMARK
Bookmark entry.

See Also:
Constant Field Values

VARIABLE

public static final int VARIABLE
Vairable entry.

See Also:
Constant Field Values

DATA_SOURCE_FOLDER

public static final int DATA_SOURCE_FOLDER
Datasource folder entry.

See Also:
Constant Field Values

BEAN

public static final int BEAN
Bean entry.

See Also:
Constant Field Values

PARAMETER_SHEET

public static final int PARAMETER_SHEET
Parameter sheet entry.

See Also:
Constant Field Values

META_TEMPLATE

public static final int META_TEMPLATE
Meta template entry.

See Also:
Constant Field Values

TABLE_STYLE

public static final int TABLE_STYLE
Table style entry.

See Also:
Constant Field Values

SCRIPT

public static final int SCRIPT
Script entry.

See Also:
Constant Field Values

REPORT_COMPONENT

public static final int REPORT_COMPONENT
Report component type.

See Also:
Constant Field Values

BEAN_FOLDER

public static final int BEAN_FOLDER
Bean folder entry.

See Also:
Constant Field Values

PARAMETER_SHEET_FOLDER

public static final int PARAMETER_SHEET_FOLDER
Parameter sheet folder entry.

See Also:
Constant Field Values

META_TEMPLATE_FOLDER

public static final int META_TEMPLATE_FOLDER
Meta template folder entry.

See Also:
Constant Field Values

TABLE_STYLE_FOLDER

public static final int TABLE_STYLE_FOLDER
Table style folder entry.

See Also:
Constant Field Values

SCRIPT_FOLDER

public static final int SCRIPT_FOLDER
Table style sub folder entry.

See Also:
Constant Field Values

DATA_MODEL

public static final int DATA_MODEL
Data Model entry.

See Also:
Constant Field Values

PARTITION

public static final int PARTITION
Physical model partition entry.

See Also:
Constant Field Values

EXTENDED_MODEL

public static final int EXTENDED_MODEL
Physical model partition entry.

See Also:
Constant Field Values

EXTENDED_PARTITION

public static final int EXTENDED_PARTITION
Extended physical model partition entry.

See Also:
Constant Field Values

EXTENDED_LOGIC_MODEL

public static final int EXTENDED_LOGIC_MODEL
Extended Logic model entry.

See Also:
Constant Field Values

VPM

public static final int VPM
Virtual private model entry.

See Also:
Constant Field Values

QUERY_FOLDER

public static final int QUERY_FOLDER
Query folder entry.

See Also:
Constant Field Values

LOCAL_QUERY_FOLDER

public static final int LOCAL_QUERY_FOLDER
Local Query folder entry.

See Also:
Constant Field Values

REPORT_WORKSHEET_FOLDER

public static final int REPORT_WORKSHEET_FOLDER
Local Worksheet folder entry.

See Also:
Constant Field Values

EMBEDDED_PS_FOLDER

public static final int EMBEDDED_PS_FOLDER
Local Worksheet folder entry.

See Also:
Constant Field Values

REPLET

public static final int REPLET
Report

See Also:
Constant Field Values

ERM

public static final int ERM
All erm entries.

See Also:
Constant Field Values

REPORT_ID

public static final String REPORT_ID
Report id property.

See Also:
Constant Field Values

WORKSHEET_TYPE

public static final String WORKSHEET_TYPE
Worksheet type.

See Also:
Constant Field Values

SHEET_DESCRIPTION

public static final String SHEET_DESCRIPTION
Worksheet description.

See Also:
Constant Field Values

REPORT_DATA_SOURCE

public static final String REPORT_DATA_SOURCE
Report data source.

See Also:
Constant Field Values

PATH_ARRAY

public static final String PATH_ARRAY
Path array.

See Also:
Constant Field Values

QUERY_TYPE

public static final String QUERY_TYPE
Query type.

See Also:
Constant Field Values

CURRENT_QUERY

public static final String CURRENT_QUERY
Current query.

See Also:
Constant Field Values

NORMAL

public static final String NORMAL
Normal query type.

See Also:
Constant Field Values

PRE_AGGREGATE

public static final String PRE_AGGREGATE
Pre-aggregate query type.

See Also:
Constant Field Values

CUBE

public static final String CUBE
Cube query type.

See Also:
Constant Field Values

CUBE_COL_TYPE

public static final String CUBE_COL_TYPE
Cube column type.

See Also:
Constant Field Values

DATA_SOURCE_TYPE

public static final String DATA_SOURCE_TYPE
Datasource type.

See Also:
Constant Field Values

DIMENSIONS

public static final int DIMENSIONS
Cube column is dimension.

See Also:
Constant Field Values

MEASURES

public static final int MEASURES
Cube column is measure.

See Also:
Constant Field Values

DATE_DIMENSIONS

public static final int DATE_DIMENSIONS
Cube column is date dimension.

See Also:
Constant Field Values
Constructor Detail

AssetEntry

public AssetEntry()
Constructor.


AssetEntry

public AssetEntry(int scope,
                  int type,
                  String path,
                  String user)
Constructor.

Method Detail

isIgnoredProperty

public static boolean isIgnoredProperty(String key)
Check if is an ignored property.


createAssetEntry

public static AssetEntry createAssetEntry(String identifier)
Create an asset entry from a string identifier. Supports the AssetEntry.toIdentifier() syntax (e.g. "1^2^__NULL__^WSName", as well as the JavaScript runQuery-worksheet identifiers. ws:LocalWSName ws:global:dir/WSName ws:USERNAME:UserWSName

Parameters:
identifier - the specified string identifier.
Returns:
the created asset entry.

createAssetEntry

public static AssetEntry createAssetEntry(Element elem)
                                   throws Exception
Create an asset entry from an xml element.

Parameters:
elem - the specified xml element.
Returns:
the created asset entry.
Throws:
Exception

createGlobalRoot

public static AssetEntry createGlobalRoot()
Create the root entry for the global scope.


createUserRoot

public static AssetEntry createUserRoot(Principal user)
Create the root entry for the user scope.


createReportRoot

public static AssetEntry createReportRoot()
Create the root entry for the report scope.


getDependencyPrefix

public static String getDependencyPrefix()
Get the dependecy prefix.

Returns:
the dependency prefix of the asset entry.

isReportDataSource

public boolean isReportDataSource()
Check if is treated as a report data source.

Returns:
true if treated as a report data source, false otherwise.

setReportDataSource

public void setReportDataSource(boolean source)
Set whether is treated as a report data source.

Parameters:
source - true if treated as a report data source, false otherwise.

getScope

public int getScope()
Get the scope of the asset entry, which should be one of the predefined types in AssetRepository like GLOBAL_SCOPE, USER_SCOPE, etc.

Returns:
the scope of the asset entry.

getType

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

Returns:
the type of the asset entry.

getPath

public String getPath()
Get the path of the asset entry.

Returns:
the path of the asset entry.

getLockPath

public String getLockPath()
Get the lock path of the asset entry.

Returns:
the lock path of the asset entry.

getUser

public String getUser()
Get the user of the asset entry.

Returns:
the user of the asset entry.

getProperty

public String getProperty(String key)
Get a property of the asset entry.

Parameters:
key - the name of the property.
Returns:
the value of the property.

setProperty

public void setProperty(String key,
                        String value)
Set a property of the asset entry.

Parameters:
key - the name of the property.
value - the value of the property, null to remove the property.

getName

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

Returns:
the name of the asset entry.

isRoot

public boolean isRoot()
Check if is root.

Returns:
true if is root, false otherwise.

isFolder

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

Returns:
true if yes, false otherwise.

isActualFolder

public boolean isActualFolder()

isWorksheet

public boolean isWorksheet()
Check if is a worksheet entry.

Returns:
true if yes, false otherwise.

isViewsheet

public boolean isViewsheet()
Check if is a viewsheet entry.

Returns:
true if yes, false otherwise.

isVSSnapshot

public boolean isVSSnapshot()
Check if is a viewsheet snapshot entry.

Returns:
true if yes, false otherwise.

isSheet

public boolean isSheet()
Check if is a sheet entry.

Returns:
true if yes, false otherwise.

isData

public boolean isData()
Check if is a data entry.

Returns:
true if yes, false otherwise.

isColumn

public boolean isColumn()
Check if is a column entry.

Returns:
true if yes, false otherwise.

isTable

public boolean isTable()
Check if is a table entry.

Returns:
true if yes, false otherwise.

isQuery

public boolean isQuery()
Check if is a query entry.

Returns:
true if yes, false otherwise.

isLogicModel

public boolean isLogicModel()
Check if is a logic model entry.

Returns:
true if yes, false otherwise.

isPhysicalFolder

public boolean isPhysicalFolder()
Check if is a physical folder entry.

Returns:
true if yes, false otherwise.

isRepositoryFolder

public boolean isRepositoryFolder()
Check if is a repository folder entry.

Returns:
true if yes, false otherwise.

isPhysicalTable

public boolean isPhysicalTable()
Check if is a physical table entry.

Returns:
true if yes, false otherwise.

isDataSource

public boolean isDataSource()
Check if is a data source entry.

Returns:
true if yes, false otherwise.

isDataSourceFolder

public boolean isDataSourceFolder()
Check if is a data source folder entry.

Returns:
true if yes, false otherwise.

isVariable

public boolean isVariable()
Check if is a variable entry.

Returns:
true if yes, false otherwise.

isBean

public boolean isBean()
Check if is a bean entry.

Returns:
true if yes, false otherwise.

isParameterSheet

public boolean isParameterSheet()
Check if is a parameter sheet entry.

Returns:
true if yes, false otherwise.

isReplet

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

Returns:
true if yes, false otherwise.

isMetaTemplate

public boolean isMetaTemplate()
Check if is a meta template entry.

Returns:
true if yes, false otherwise.

isTableStyle

public boolean isTableStyle()
Check if is a table style entry.

Returns:
true if yes, false otherwise.

isScript

public boolean isScript()
Check if is a script function entry.

Returns:
true if yes, false otherwise.

isBeanFolder

public boolean isBeanFolder()
Check if is a bean folder entry.

Returns:
true if yes, false otherwise.

isParameterSheetFolder

public boolean isParameterSheetFolder()
Check if is a parameter sheet folder entry.

Returns:
true if yes, false otherwise.

isMetaTemplateFolder

public boolean isMetaTemplateFolder()
Check if is a meta template folder entry.

Returns:
true if yes, false otherwise.

isTableStyleFolder

public boolean isTableStyleFolder()
Check if is a table style folder entry.

Returns:
true if yes, false otherwise.

isTableStyleSubFolder

public boolean isTableStyleSubFolder()
Check if is a table style sub folder entry.

Returns:
true if yes, false otherwise.

isScriptFolder

public boolean isScriptFolder()
Check if is a script folder entry.

Returns:
true if yes, false otherwise.

isEmbeddedParameterSheet

public boolean isEmbeddedParameterSheet()
Check if is an embedded parameter sheet entry.

Returns:
true if yes, false otherwise.

isLocalQueryFolder

public boolean isLocalQueryFolder()
Check if is a local query folder entry.

Returns:
true if yes, false otherwise.

isLocalQuery

public boolean isLocalQuery()
Check if is a local query folder entry.

Returns:
true if yes, false otherwise.

isReportWorksheetFolder

public boolean isReportWorksheetFolder()
Check if is a local worksheet folder entry.

Returns:
true if yes, false otherwise.

isEmbeddedPSFolder

public boolean isEmbeddedPSFolder()
Check if is a local parameter sheet folder entry.

Returns:
true if yes, false otherwise.

isLocalWorksheet

public boolean isLocalWorksheet()
Check if is a local worksheet entry.

Returns:
true if yes, false otherwise.

isDataModel

public boolean isDataModel()
Check if is a data model entry.

Returns:
true if yes, false otherwise.

isPartition

public boolean isPartition()
Check if is a partion entry.

Returns:
true if yes, false otherwise.

isExtendedPartition

public boolean isExtendedPartition()
Check if is a extended partion entry.

Returns:
true if yes, false otherwise.

isExtendedLogicModel

public boolean isExtendedLogicModel()
Check if is a extended logic model entry.

Returns:
true if yes, false otherwise.

isExtendedModel

public boolean isExtendedModel()
Check if is a extended model entry.

Returns:
true if yes, false otherwise.

isVPM

public boolean isVPM()
Check if is a vpm entry.

Returns:
true if yes, false otherwise.

isQueryFolder

public boolean isQueryFolder()
Check if is a query folder entry.

Returns:
true if yes, false otherwise.

isMyReportsFolder

public boolean isMyReportsFolder()
Check if is the My Reports folder entry.

Returns:
true if yes, false otherwise.

isWorksheetFolder

public boolean isWorksheetFolder()
Check if is a worksheet folder entry.

Returns:
true if yes, false otherwise.

isEditable

public boolean isEditable()
Check if is editable.

Returns:
true if yes, false otherwise.

getParentPath

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

Returns:
the parent path of the asset entry.

getParent

public AssetEntry getParent()
Get the parent entry of the asset entry.

Returns:
the parent entry of the asset entry.

isAncestor

public boolean isAncestor(AssetEntry entry)
Check if is the ancestor of another entry.

Parameters:
entry - the specified entry.
Returns:
true if is the ancestor, false otherwise.

toString

public String toString()
Get the string representation.

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

toView

public String toView()
Get the string to display.

Returns:
the string to display.

toDescription

public String toDescription()
Get the description for debug only.


getAlias

public String getAlias()
Get a alias of the asset entry.

Returns:
the alias of the folder.

setAlias

public void setAlias(String alias)
Set a alias of the asset entry.

Parameters:
alias - the alias of the property.

getDescription

public String getDescription()
Get the description without localization.

Returns:
the description.

getDescription

public String getDescription(boolean localize)
Get the description without localization.

Parameters:
localize - true if the description needs to localize.
Returns:
the description.

getDescription

public String getDescription(boolean localize,
                             boolean isAsset)
Get the description without localization.

Parameters:
localize - true if the description needs to localize.
isAsset - true if the description is asset description.
Returns:
the description.

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.

isValid

public boolean isValid()
Check if the asset entry is valid.

Returns:
true if yes, false otherwise.

getPropertyKeys

public Enumeration getPropertyKeys()
Get the keys of the properties.


copyProperties

public void copyProperties(AssetEntry entry)
Copy properties from another asset entry.

Parameters:
entry - the specified asset entry.

getDependencyPattern

public String getDependencyPattern()
Get the dependecy pattern.

Returns:
the dependency pattern of the asset entry.

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.

writeData

public void writeData(DataOutputStream dos)
Write data to a DataOutputStream.

Specified by:
writeData in interface inetsoft.util.DataSerializable
Parameters:
dos - the destination DataOutputStream.
Throws:
IOException.

writeProperties2

public void writeProperties2(DataOutputStream dos)
Write properties.

Parameters:
dos - the destination DataOutputStream.

parseXML

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

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Parameters:
elem - the specified xml element.
Throws:
Exception

resetMVOptions

public void resetMVOptions()
Reset mv options.


parseData

public boolean parseData(DataInputStream input)
Parse data from an InputStream.

Specified by:
parseData in interface inetsoft.util.DataSerializable
Parameters:
input - the source DataInputStream.

toIdentifier

public String toIdentifier()
To string identifier.

Returns:
the string identifier of the asset entry.

getSheetName

public String getSheetName()
If the entry is sheet, get fullpath and scope as the sheet name.


clone

public Object clone()
Clone the object.

Specified by:
clone in interface AssetObject
Overrides:
clone in class Object
Returns:
the cloned object.

getCreatedDate

public Date getCreatedDate()
Get the created date

Returns:
the created date

setCreatedDate

public void setCreatedDate(Date createdDate)
Set the created date

Parameters:
createdDate - the created date

getCreatedUsername

public String getCreatedUsername()
Get the created username

Returns:
the created username

setCreatedUsername

public void setCreatedUsername(String createdUsername)
Set the created username

Parameters:
createdUsername - the created username

getModifiedDate

public Date getModifiedDate()
Get the modified date

Returns:
the modified date

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Set the modified date

Parameters:
modifiedDate - the modified date

getModifiedUsername

public String getModifiedUsername()
Get the modified username

Returns:
the modified username

setModifiedUsername

public void setModifiedUsername(String modifiedUsername)
Set modified username

Parameters:
modifiedUsername - the modified username

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