Style Intelligence v12.0

inetsoft.uql.asset
Class AbstractWSAssembly

java.lang.Object
  extended by inetsoft.uql.asset.AbstractAssembly
      extended by inetsoft.uql.asset.AbstractWSAssembly
All Implemented Interfaces:
Assembly, AssetObject, inetsoft.uql.asset.internal.VariableProvider, WSAssembly, inetsoft.util.XMLSerializable, Serializable, Cloneable
Direct Known Subclasses:
AbstractTableAssembly, DefaultConditionAssembly, DefaultDateRangeAssembly, DefaultNamedGroupAssembly, DefaultVariableAssembly, MirrorConditionAssembly, MirrorDateRangeAssembly, MirrorNamedGroupAssembly, MirrorVariableAssembly

public abstract class AbstractWSAssembly
extends AbstractAssembly
implements WSAssembly

Abstract worksheet assembly, implements most methods defined in WSAssembly.

See Also:
Serialized Form

Field Summary
protected  inetsoft.uql.asset.internal.WSAssemblyInfo info
           
protected  Worksheet ws
           
 
Fields inherited from interface inetsoft.uql.asset.Assembly
CUBE_VS, DETAIL, EMBEDDED, FIELD, SELECTION, TABLE_VS
 
Constructor Summary
AbstractWSAssembly()
          Constructor.
AbstractWSAssembly(Worksheet ws, String name)
          Constructor.
 
Method Summary
 void checkDependency()
          Check if the dependency is valid.
 void checkValidity()
          Check if the assembly is valid.
 Object clone()
          Clone the object.
 WSAssembly copyAssembly(String name)
          Copy the assembly.
protected  inetsoft.uql.asset.internal.WSAssemblyInfo createInfo()
          Create assembly info.
static WSAssembly createWSAssembly(Element elem, Worksheet ws)
          Create an assembly from an xml element.
protected  String getClassName(boolean compact)
          Get the class name.
 String getDescription()
          Get the description.
 inetsoft.uql.asset.internal.AssemblyInfo getInfo()
          Get the assembly info.
 String getName()
          Get the name.
 Point getPosition()
          Get the position.
 AbstractSheet getSheet()
          Get the sheet container.
 Dimension getSize()
          Get the size.
 Worksheet getWorksheet()
          Get the worksheet.
 inetsoft.uql.asset.internal.WSAssemblyInfo getWSAssemblyInfo()
          Get the worksheet assembly info.
 boolean isComposed()
          Check if is composed.
 boolean isCondition()
          Check if is a condition assembly.
 boolean isDateCondition()
          Check if is a date condition assembly.
 boolean isIconized()
          Check if the assembly is iconized.
 boolean isNamedGroup()
          Check if is a named group assembly.
 boolean isOuter()
          Check if the assembly is outer.
 boolean isTable()
          Check if is a table assembly.
 boolean isVariable()
          Check if is a variable assembly.
 void reset()
          Reset the assembly.
 void setDescription(String desc)
          Set the description.
 void setIconized(boolean iconized)
          Set iconized option.
protected  void setName(String name)
          Set the name.
 void setOuter(boolean outer)
          Set outer option.
 void setPosition(Point pos)
          Set the position.
 void setSize(Dimension size)
          Set the size.
 void setVisible(boolean visible)
          Set the visible flag.
 void setWorksheet(Worksheet ws)
          Set the worksheet.
 boolean update()
          Update the assembly.
 
Methods inherited from class inetsoft.uql.asset.AbstractAssembly
addr, equals, getAbsoluteName, getAssemblyEntry, getBounds, hashCode, isEditable, isVisible, parseAttributes, parseContents, parseXML, setBounds, toString, writeAttributes, writeContents, writeXML
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface inetsoft.uql.asset.WSAssembly
replaceVariables
 
Methods inherited from interface inetsoft.uql.asset.Assembly
addr, getAbsoluteName, getAssemblyEntry, getAssemblyType, getBounds, getDependeds, getMinimumSize, isEditable, isVisible, renameDepended, setBounds
 
Methods inherited from interface inetsoft.util.XMLSerializable
parseXML, writeXML
 
Methods inherited from interface inetsoft.uql.asset.internal.VariableProvider
getAllVariables
 

Field Detail

ws

protected Worksheet ws

info

protected inetsoft.uql.asset.internal.WSAssemblyInfo info
Constructor Detail

AbstractWSAssembly

public AbstractWSAssembly()
Constructor.


AbstractWSAssembly

public AbstractWSAssembly(Worksheet ws,
                          String name)
Constructor.

Method Detail

createWSAssembly

public static WSAssembly createWSAssembly(Element elem,
                                          Worksheet ws)
                                   throws Exception
Create an assembly from an xml element.

Parameters:
elem - the specified xml element.
ws - the specified worksheet.
Returns:
the created assembly.
Throws:
Exception

getClassName

protected String getClassName(boolean compact)
Get the class name.

Overrides:
getClassName in class AbstractAssembly

createInfo

protected inetsoft.uql.asset.internal.WSAssemblyInfo createInfo()
Create assembly info.

Returns:
the associated assembly info.

getInfo

public inetsoft.uql.asset.internal.AssemblyInfo getInfo()
Get the assembly info.

Specified by:
getInfo in interface Assembly
Returns:
the associated assembly info.

getName

public String getName()
Get the name.

Specified by:
getName in interface Assembly
Returns:
the name of the assemmbly.

setName

protected void setName(String name)
Set the name.

Parameters:
name - the specified name.

getWSAssemblyInfo

public inetsoft.uql.asset.internal.WSAssemblyInfo getWSAssemblyInfo()
Get the worksheet assembly info.

Specified by:
getWSAssemblyInfo in interface WSAssembly
Returns:
the worksheet assembly info.

isComposed

public boolean isComposed()
Check if is composed.

Specified by:
isComposed in interface WSAssembly
Returns:
true if composed, false otherwise.

getDescription

public String getDescription()
Get the description.

Specified by:
getDescription in interface WSAssembly
Returns:
the description of the assemmbly.

setDescription

public void setDescription(String desc)
Set the description.

Specified by:
setDescription in interface WSAssembly
Parameters:
desc - the specified description.

isIconized

public boolean isIconized()
Check if the assembly is iconized.

Specified by:
isIconized in interface WSAssembly
Returns:
true if iconized, false otherwise.

setIconized

public void setIconized(boolean iconized)
Set iconized option.

Specified by:
setIconized in interface WSAssembly
Parameters:
iconized - true indicated iconized.

isOuter

public boolean isOuter()
Check if the assembly is outer.

Specified by:
isOuter in interface WSAssembly
Returns:
true if outer, false otherwise.

setOuter

public void setOuter(boolean outer)
Set outer option.

Specified by:
setOuter in interface WSAssembly
Parameters:
outer - true indicated outer.

checkValidity

public void checkValidity()
                   throws Exception
Check if the assembly is valid.

Specified by:
checkValidity in interface WSAssembly
Throws:
Exception

checkDependency

public void checkDependency()
                     throws InvalidDependencyException
Check if the dependency is valid.

Specified by:
checkDependency in interface Assembly
Throws:
InvalidDependencyException

getPosition

public Point getPosition()
Get the position.

Specified by:
getPosition in interface Assembly
Returns:
the position of the assembly.

setPosition

public void setPosition(Point pos)
Set the position.

Specified by:
setPosition in interface Assembly

getSize

public Dimension getSize()
Get the size.

Specified by:
getSize in interface Assembly
Returns:
the size of the assembly.

setSize

public void setSize(Dimension size)
Set the size.

Specified by:
setSize in interface Assembly
Parameters:
size - the specified size.

isDateCondition

public boolean isDateCondition()
Check if is a date condition assembly.

Specified by:
isDateCondition in interface WSAssembly
Returns:
true if yes, false otherwise.

isCondition

public boolean isCondition()
Check if is a condition assembly.

Specified by:
isCondition in interface WSAssembly
Returns:
true if yes, false otherwise.

isNamedGroup

public boolean isNamedGroup()
Check if is a named group assembly.

Specified by:
isNamedGroup in interface WSAssembly
Returns:
true if yes, false otherwise.

isVariable

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

Specified by:
isVariable in interface WSAssembly
Returns:
true if yes, false otherwise.

isTable

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

Specified by:
isTable in interface WSAssembly
Returns:
true if yes, false otherwise.

setWorksheet

public void setWorksheet(Worksheet ws)
Set the worksheet.

Specified by:
setWorksheet in interface WSAssembly
Parameters:
ws - the specified worksheet.

getWorksheet

public Worksheet getWorksheet()
Get the worksheet.

Specified by:
getWorksheet in interface WSAssembly
Returns:
the worksheet of the assembly.

setVisible

public void setVisible(boolean visible)
Set the visible flag.

Specified by:
setVisible in interface WSAssembly
Parameters:
visible - true if visible, false otherwise.

reset

public void reset()
Reset the assembly.

Specified by:
reset in interface WSAssembly

copyAssembly

public WSAssembly copyAssembly(String name)
Copy the assembly.

Specified by:
copyAssembly in interface WSAssembly
Parameters:
name - the specified new assembly name.
Returns:
the copied assembly.

clone

public Object clone()
Clone the object.

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

getSheet

public AbstractSheet getSheet()
Get the sheet container.

Specified by:
getSheet in interface Assembly
Returns:
the sheet container.

update

public boolean update()
Update the assembly.

Specified by:
update in interface WSAssembly
Returns:
true if successful, false otherwise.

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