|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.asset.AbstractSheet
inetsoft.uql.asset.Worksheet
public class Worksheet
Worksheet like a spreadsheet, contains condition/named group/variable/table Assemblies, of which a primary assembly for binding.
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
Worksheet()
Constructor. |
|
| Method Summary | |
|---|---|
boolean |
addAssembly(WSAssembly assembly)
Add an assembly. |
boolean |
addOuterDependency(AssetEntry entry)
Add an outer dependency. |
void |
addParseThread(Runnable runnable)
Add a thread to init parse emebedded data. |
void |
autoLayout()
Rearrange the assemblies into a tree like structure where the root is displayed on top, and children below, and so on. |
void |
checkDependencies()
Check if the dependencies are valid. |
void |
checkValidity()
Check if the worksheet is valid. |
Object |
clone()
Clone the object. |
boolean |
containsAssembly(Assembly assembly)
Check if contains an assembly. |
boolean |
containsAssembly(String name)
Check if contains an assembly. |
void |
dispose()
Dispose executing assembly. |
UserVariable[] |
getAllVariables()
Get all variables in the condition value list. |
Assembly[] |
getAssemblies()
Get all the assemblies. |
Assembly[] |
getAssemblies(boolean sort)
Get all the assemblies. |
Assembly |
getAssembly(AssemblyEntry entry)
Get an assembly by its entry. |
Assembly |
getAssembly(String name)
Get an assembly by its name. |
Assembly |
getCubeTableAssembly(String name)
Get cube table assembly. |
AssemblyRef[] |
getDependeds(AssemblyEntry entry)
Get the assemblies depended on of an assembly in a sheet. |
AssemblyRef[] |
getDependeds(AssemblyEntry entry,
boolean view,
boolean out)
Get the assemblies depended on of an assembly in a viewsheet. |
AssemblyRef[] |
getDependings(AssemblyEntry entry)
Get the depending assemblies in a worksheet. |
String |
getDescription()
Get the description of the worksheet. |
protected int |
getGap()
Get the gap between two assemblies. |
AssetEntry[] |
getOuterDependencies()
Get the outer dependencies. |
AssetEntry[] |
getOuterDependents()
Get the outer dependents. |
WSAssembly |
getPrimaryAssembly()
Get the primary assembly. |
String |
getPrimaryAssemblyName()
Get the primary assembly name. |
Dimension |
getSize()
Get the size of the worksheet. |
int |
getType()
Get the type of the worksheet. |
TableAssembly |
getVSTableAssembly(String bname)
Get the table assembly used in viewsheet by the name of the base assembly. |
WorksheetInfo |
getWorksheetInfo()
Get the worksheet info. |
boolean |
isCondition()
Check if is a condition worksheet. |
boolean |
isFrozen()
Check if this worksheet is frozen. |
boolean |
isNamedGroup()
Check if is a named group worksheet. |
boolean |
isOffline()
return if it's offline worksheet or not. |
boolean |
isShowWarning()
return if show warning dialog after rename or not. |
boolean |
isTable()
Check if is a table worksheet. |
boolean |
isVariable()
Check if is a variable worksheet. |
void |
parseXML(Element elem)
Method to parse an xml segment. |
boolean |
removeAssembly(Assembly assembly)
Remove an assembly. |
boolean |
removeAssembly(String name)
Remove an assembly. |
void |
removeOuterDependencies()
Remove all the outer dependencies. |
boolean |
removeOuterDependency(AssetEntry entry)
Remove an outer dependency. |
boolean |
renameAssembly(String oname,
String nname,
boolean both)
Rename an assembly. |
void |
renameOuterDependent(AssetEntry oentry,
AssetEntry nentry)
Rename an outer dependent. |
void |
replaceVariables(VariableTable vars)
Replace all embeded user variables. |
void |
reset()
Reset the worksheet. |
void |
setOffline(boolean offline)
Set it's offline worksheet or not. |
boolean |
setPrimaryAssembly(Assembly assembly)
Set the primary assembly. |
boolean |
setPrimaryAssembly(String name)
Set the primary assembly. |
void |
setShowWarning(boolean w)
set show warning dialog after rename or not. |
boolean |
setWorksheetInfo(WorksheetInfo winfo)
Set the worksheet info. |
boolean |
update()
Update the references in worksheet. |
boolean |
update(AssetRepository rep,
AssetEntry entry,
Principal user)
Update this worksheet. |
boolean |
updateMirrors(AssetRepository engine,
Principal user,
String rid)
Update the auto update outer mirrors in the worksheet. |
protected void |
writeContents(PrintWriter writer)
Write the content part(child node) of XML segment. |
void |
writeData(JarOutputStream out)
Write out data content in each assembly. |
void |
writeXML(PrintWriter writer)
Write the xml segment to print writer. |
| Methods inherited from class inetsoft.uql.asset.AbstractSheet |
|---|
addActionListener, addr, fireEvent, getActualBounds, getColWidth, getColX, getCreated, getCreatedBy, getLastModified, getLastModified, getLastModifiedBy, getLastSize, getLayoutBounds, getLocalQueryRepository, getRowHeight, getRowY, isFireEvent, isLayoutVisible, layout, layout, layout, moveY, parseWHXML, removeActionListener, removeActionListeners, resetSize, setColWidth, setCreated, setCreatedBy, setFireEvent, setLastModified, setLastModifiedBy, setLastSize, setLocalQueryRepository, setRowHeight, shrink, writeWHXML |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Worksheet()
| Method Detail |
|---|
public int getType()
getType in class AbstractSheetpublic boolean isCondition()
public boolean isNamedGroup()
public boolean isVariable()
public boolean isTable()
public String getPrimaryAssemblyName()
public WSAssembly getPrimaryAssembly()
public boolean setPrimaryAssembly(String name)
name - the specified primary assembly.
public boolean setPrimaryAssembly(Assembly assembly)
assembly - the specified primary assembly.
public WorksheetInfo getWorksheetInfo()
public boolean setWorksheetInfo(WorksheetInfo winfo)
public boolean containsAssembly(String name)
containsAssembly in class AbstractSheetname - the specified assembly name.
public boolean containsAssembly(Assembly assembly)
assembly - the specified assembly.
public Assembly getAssembly(AssemblyEntry entry)
getAssembly in class AbstractSheetentry - the specified assembly entry.
public Assembly getAssembly(String name)
getAssembly in class AbstractSheetname - the specified assembly name.
public TableAssembly getVSTableAssembly(String bname)
bname - the specified base assembly name.
public Assembly[] getAssemblies()
getAssemblies in class AbstractSheetpublic Assembly[] getAssemblies(boolean sort)
sort - true to sort the assembliies by dependency,
false otherwise.
public boolean addAssembly(WSAssembly assembly)
assembly - the specified assembly, null to remove it.
public boolean removeAssembly(String name)
name - the specified assembly name.
public boolean removeAssembly(Assembly assembly)
assembly - the specified assembly.
public boolean renameAssembly(String oname,
String nname,
boolean both)
oname - the specified old assembly name.nname - the specified new assembly name.both - true to rename both assembly name and variable name,
false to rename assembly name only.
protected int getGap()
getGap in class AbstractSheetpublic Dimension getSize()
getSize in class AbstractSheetpublic String getDescription()
getDescription in class AbstractSheet
public void checkValidity()
throws Exception
checkValidity in class AbstractSheetException
public void checkDependencies()
throws InvalidDependencyException
checkDependencies in class AbstractSheetInvalidDependencyExceptionpublic void replaceVariables(VariableTable vars)
vars - the specified variable table.public UserVariable[] getAllVariables()
getAllVariables in interface inetsoft.uql.asset.internal.VariableProviderpublic AssemblyRef[] getDependings(AssemblyEntry entry)
entry - the specified assembly entry.
public boolean update(AssetRepository rep,
AssetEntry entry,
Principal user)
update in class AbstractSheetrep - the specified asset repository.entry - the specified entry stored in.user - the specified principal.public boolean update()
public boolean updateMirrors(AssetRepository engine,
Principal user,
String rid)
engine - the specified asset repository.user - the specified user.rid - the specified report id.
public AssetEntry[] getOuterDependents()
getOuterDependents in class AbstractSheet
public void renameOuterDependent(AssetEntry oentry,
AssetEntry nentry)
renameOuterDependent in class AbstractSheetoentry - the specified old entry.nentry - the specified new entry.public AssetEntry[] getOuterDependencies()
getOuterDependencies in class AbstractSheetpublic boolean addOuterDependency(AssetEntry entry)
addOuterDependency in class AbstractSheetentry - the specified entry.
public boolean removeOuterDependency(AssetEntry entry)
removeOuterDependency in class AbstractSheetentry - the specified entry.
public void removeOuterDependencies()
removeOuterDependencies in class AbstractSheetpublic void autoLayout()
public void reset()
reset in class AbstractSheetpublic AssemblyRef[] getDependeds(AssemblyEntry entry)
getDependeds in class AbstractSheetentry - the specified assembly entry.
public AssemblyRef[] getDependeds(AssemblyEntry entry,
boolean view,
boolean out)
getDependeds in class AbstractSheetentry - the specified assembly entry.view - true to include view, false otherwise.out - out to include out, false otherwise.public void writeXML(PrintWriter writer)
writeXML in interface inetsoft.util.XMLSerializablewriter - the destination print writer.protected void writeContents(PrintWriter writer)
public void parseXML(Element elem)
throws Exception
parseXML in interface inetsoft.util.XMLSerializableelem - the specified xml element.
Exceptionpublic Object clone()
clone in interface AssetObjectclone in class AbstractSheetpublic Assembly getCubeTableAssembly(String name)
public boolean isFrozen()
public void setOffline(boolean offline)
public boolean isOffline()
public boolean isShowWarning()
public void setShowWarning(boolean w)
public void writeData(JarOutputStream out)
writeData in class AbstractSheetpublic void dispose()
public void addParseThread(Runnable runnable)
runnable - the parse thread.
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||