Style Intelligence v12.0

inetsoft.uql.asset
Class AssetVariable

java.lang.Object
  extended by inetsoft.uql.schema.XVariable
      extended by inetsoft.uql.schema.UserVariable
          extended by inetsoft.uql.asset.AssetVariable
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable, Cloneable

public class AssetVariable
extends UserVariable

Asset variable represents a user defined variable.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.uql.schema.UserVariable
CHECKBOXES, COMBOBOX, DATE_COMBOBOX, LIST, NONE, RADIO_BUTTONS
 
Constructor Summary
AssetVariable()
          Constructor.
AssetVariable(String name)
          Constructor.
 
Method Summary
 boolean equals(Object obj)
          Check if equals another object.
 int getDisplayStyle()
          Get the display style.
 DataRef getLabelAttribute()
          Get the label attribute.
 TableAssembly getTable()
          Get the table assembly.
 String getTableName()
          Get the table name.
 DataRef getValueAttribute()
          Get the value attribute.
 boolean isPromptWithDValue()
          Check is the value of the variable needs to be enter by users.
protected  void parseAttributes(Element elem)
          Parse attributes.
protected  void parseContents(Element elem)
          Parse contents.
 void setDisplayStyle(int style)
          Set the display style.
 void setLabelAttribute(DataRef lattr)
          Set the label attribute.
 void setPromptWithDValue(boolean promptWithDValue)
          Set whether to prompt users for the variable if contains default value.
 void setTableName(String table)
          Set the table name.
 void setValueAttribute(DataRef vattr)
          Set the value attribute.
 String toString()
          Get the string representation.
 boolean update(Worksheet ws)
          Update the assembly.
protected  void writeAttributes(PrintWriter writer)
          Write attributes.
protected  void writeContents(PrintWriter writer)
          Write contents.
 
Methods inherited from class inetsoft.uql.schema.UserVariable
clone, evaluate, getAlias, getChoiceQuery, getChoices, getToolTip, getTypedValues, getTypeNode, getValueNode, getValues, hashCode, isCustomization, isEmbedded, isHidden, isLocalQuery, isLocalWorksheet, isMultipleSelection, isPrompt, isSortValue, isUsedInOneOf, parseXML, setAlias, setChoiceQuery, setChoices, setCustomization, setEmbedded, setHidden, setLocalQuery, setLocalWorksheet, setMultipleSelection, setPrompt, setSortValue, setToolTip, setTypeNode, setUsedInOneOf, setValueNode, setValues, writeXML
 
Methods inherited from class inetsoft.uql.schema.XVariable
getName, getSource, parse, setName, setSource
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AssetVariable

public AssetVariable()
Constructor.


AssetVariable

public AssetVariable(String name)
Constructor.

Method Detail

getDisplayStyle

public int getDisplayStyle()
Get the display style.

Overrides:
getDisplayStyle in class UserVariable
Returns:
the display style.

setDisplayStyle

public void setDisplayStyle(int style)
Set the display style.

Parameters:
style - the specified display style.

getTableName

public String getTableName()
Get the table name.

Returns:
the table assembly.

setTableName

public void setTableName(String table)
Set the table name.

Parameters:
table - the specified table assembly.

getTable

public TableAssembly getTable()
Get the table assembly.

Returns:
the table assembly.

getValueAttribute

public DataRef getValueAttribute()
Get the value attribute.

Returns:
the value attribute.

setValueAttribute

public void setValueAttribute(DataRef vattr)
Set the value attribute.

Parameters:
vattr - the specified value attribute.

getLabelAttribute

public DataRef getLabelAttribute()
Get the label attribute.

Returns:
the label attribute.

setLabelAttribute

public void setLabelAttribute(DataRef lattr)
Set the label attribute.

Parameters:
lattr - the specified label attribute.

setPromptWithDValue

public void setPromptWithDValue(boolean promptWithDValue)
Set whether to prompt users for the variable if contains default value.

Parameters:
promptWithDValue - true if the variable should be entered by users at runtime with default value.

isPromptWithDValue

public boolean isPromptWithDValue()
Check is the value of the variable needs to be enter by users.


update

public boolean update(Worksheet ws)
Update the assembly.

Parameters:
ws - the associated worksheet.
Returns:
true if successful, false otherwise.

writeContents

protected void writeContents(PrintWriter writer)
Write contents.

Overrides:
writeContents in class UserVariable
Parameters:
writer - the specified print writer.

parseContents

protected void parseContents(Element elem)
                      throws Exception
Parse contents.

Overrides:
parseContents in class UserVariable
Parameters:
elem - the specified xml element.
Throws:
Exception

writeAttributes

protected void writeAttributes(PrintWriter writer)
Write attributes.

Overrides:
writeAttributes in class UserVariable
Parameters:
writer - the specified print writer.

parseAttributes

protected void parseAttributes(Element elem)
                        throws Exception
Parse attributes.

Overrides:
parseAttributes in class UserVariable
Parameters:
elem - the specified xml element.
Throws:
Exception

equals

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

Overrides:
equals in class UserVariable
Returns:
true if equals, false otherwise.

toString

public String toString()
Get the string representation.

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

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