LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyTreemapConfiguration

java.lang.Object
  extended by leon.info.LyTag
      extended by leon.info.LyInfo
          extended by leon.info.LyObjectInfo
              extended by leon.info.LyTreemapConfiguration
All Implemented Interfaces:
java.lang.Cloneable, LyExtraInfoInterface, LyCommentInterface

public final class LyTreemapConfiguration
extends LyObjectInfo
implements LyExtraInfoInterface

This class represents a treemap configuration. It contains all the parameters that may be defined by the user.

See Also:
LyObjectInfo, LyFilter

Nested Class Summary
static class LyTreemapConfiguration.Aggregation
          Algorithms for aggregation.
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
 
Fields inherited from class leon.info.LyObjectInfo
NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL
 
Constructor Summary
LyTreemapConfiguration(java.lang.String id, LyObjectInfo objectInfo, java.lang.String name, int hierarchyLevels, LyTreemapConfiguration.Aggregation aggregationType, boolean filterActive, boolean filterShowAll, java.lang.String minColor, java.lang.String maxColor, java.lang.String[] thresholdColors, java.lang.String borderSizes, java.lang.String labelStyles, java.lang.String user)
          Constructor for a treemap configuration.
 
Method Summary
 LyTreemapConfiguration cloneTreemapConfiguration()
          Clone a treemap configuration.
 boolean deleteFile()
          Method for deleting preference file.
 void free()
          Method for freeing extra info (and sub-infos).
 LyFieldInfo getAggregationFieldInfo()
          Get the field info used to compute aggregations in this treemap configuration.
 LyTreemapConfiguration.Aggregation getAggregationType()
          Get the aggregation type.
 java.lang.String getBorderSizes()
          Get border sizes of this treemap configuration.
 LyFieldInfo getColorFieldInfo()
          Get the field info used to compute the color of this treemap configuration.
 LyFilter getFilter()
          Get filter used by this treemap configuration.
 LyInfoList<LyFieldInfo> getHierarchyFieldInfos()
          Gets list of field infos of this treemap configuration.
 int getHierarchyLevels()
          Return the hierarchy levels for this treemap configuration.
 java.lang.String getLabelStyles()
          Get label styles of this treemap configuration.
 java.lang.String getMaxColor()
          Get maximum color of this treemap configuration.
 java.lang.String getMinColor()
          Get minimum color of this treemap configuration.
 LyObjectInfo getObjectInfo()
          Get object info referred by this treemap configuration.
 LyFieldInfo getSizeFieldInfo()
          Get the field info used to compute the size of this treemap configuration.
 java.lang.String[] getThresholdColors()
          Get the list of threshold colors of this treemap configuration.
 java.lang.String getUser()
          Get owner of this treemap configuration.
 boolean isFilterActive()
          Indicates whether filter is active or not in this treemap configuration.
 boolean isFilterShowAll()
          Indicates whether filter shows all object or not in this treemap configuration.
 boolean saveFile(LyXmlWriterInterface writer)
          Method for saving preference file.
 void setAggregationFieldInfo(LyFieldInfo aggregationField)
          Set the field info used to compute aggregations.
 void setAggregationType(LyTreemapConfiguration.Aggregation aggregationType)
          Set the aggregation type.
 void setBorderSizes(java.lang.String borderSizes)
          Set the border sizes.
 void setColorFieldInfo(LyFieldInfo colorField)
          Set the field info used to compute the colors.
 void setFilter(LyFilter filter)
          Sets the filter used by this treemap configuration.
 void setFilterActive(boolean active)
          Set the activated state for filter.
 void setFilterShowAll(boolean showAll)
          Set the show all state for filter.
 void setHierarchyFieldInfos(LyInfoList<LyFieldInfo> fieldInfos)
          Sets list of hierarchy field infos of this treemap configuration.
 void setHierarchyLevels(int hierarchyLevels)
          Set the hierarchy levels.
 void setLabelStyles(java.lang.String labelStyles)
          Set the label styles.
 void setMaxColor(java.lang.String maxColor)
          Set the maximum color.
 void setMinColor(java.lang.String minColor)
          Set the minimum color.
 void setSizeFieldInfo(LyFieldInfo sizeField)
          Set the field info used to compute the sizes.
 void setThresholdColors(java.lang.String[] colors)
          Set the list of threshold colors.
 void writeXml(java.io.PrintWriter pw)
          Writes XML corresponding to this filter element.
 void writeXml(java.io.PrintWriter pw, boolean header, boolean body)
          Method to rewrite XML corresponding to this component.
 
Methods inherited from class leon.info.LyObjectInfo
clone, getAlias, getData, getDataList, getDatas, getFilePrefix, getGroup, getInternalAlias, getInternalFilePrefix, getInternalName, getMarks, getName, getTemplate, getTip, getUserData, hasMark, hasMarks, hasTemplate, isTemplate, putData, putData, removeData, toName
 
Methods inherited from class leon.info.LyInfo
getApplication, getFile, getId, getInclude, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString
 
Methods inherited from class leon.info.LyTag
getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface leon.info.infointerface.LyExtraInfoInterface
getFile, setFile
 
Methods inherited from interface leon.parser.LyCommentInterface
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values
Constructor Detail

LyTreemapConfiguration

public LyTreemapConfiguration(java.lang.String id,
                              LyObjectInfo objectInfo,
                              java.lang.String name,
                              int hierarchyLevels,
                              LyTreemapConfiguration.Aggregation aggregationType,
                              boolean filterActive,
                              boolean filterShowAll,
                              java.lang.String minColor,
                              java.lang.String maxColor,
                              java.lang.String[] thresholdColors,
                              java.lang.String borderSizes,
                              java.lang.String labelStyles,
                              java.lang.String user)
Constructor for a treemap configuration.

Parameters:
id - the identifier of the treemap configuration.
objectInfo - The concerned object info.
name - the name of the treemap configuration.
hierarchyLevels - hierarchy levels of the treemap configuration.
aggregationType - aggregation type of the treemap configuration.
filterActive - indicates if filter is active in the treemap configuration.
filterShowAll - indicates if filter shows all the objects in the treemap configuration.
minColor - min color of the treemap configuration.
maxColor - max color of the treemap configuration.
thresholdColors - list of threshold colors of the treemap configuration.
borderSizes - sizes of the borders of the treemap configuration.
labelStyles - styles of the labels of the treemap configuration.
user - the id of the user that owns the treemap configuration.
Method Detail

cloneTreemapConfiguration

public LyTreemapConfiguration cloneTreemapConfiguration()
Clone a treemap configuration.


saveFile

public boolean saveFile(LyXmlWriterInterface writer)
Method for saving preference file.

Specified by:
saveFile in interface LyExtraInfoInterface
Returns:
True if successful.

free

public void free()
Method for freeing extra info (and sub-infos).

Specified by:
free in interface LyExtraInfoInterface

deleteFile

public boolean deleteFile()
Method for deleting preference file.

Specified by:
deleteFile in interface LyExtraInfoInterface
Returns:
True if successful.

writeXml

public void writeXml(java.io.PrintWriter pw,
                     boolean header,
                     boolean body)
Method to rewrite XML corresponding to this component.

Specified by:
writeXml in interface LyExtraInfoInterface
Parameters:
pw - The printWriter on which the XML is written.
header - Boolean indicating if header must be written.
header - Boolean indicating if body must be written.

writeXml

public void writeXml(java.io.PrintWriter pw)
Writes XML corresponding to this filter element.

Specified by:
writeXml in interface LyExtraInfoInterface
Parameters:
pw - PrintWriter on which the XML is written.

getObjectInfo

public LyObjectInfo getObjectInfo()
Get object info referred by this treemap configuration.

Returns:
The concerned object info (action or classInfo).

getFilter

public LyFilter getFilter()
Get filter used by this treemap configuration.

Returns:
The concerned filter.

getSizeFieldInfo

public LyFieldInfo getSizeFieldInfo()
Get the field info used to compute the size of this treemap configuration.

Returns:
Field info used to compute the size in this treemap configuration.

getColorFieldInfo

public LyFieldInfo getColorFieldInfo()
Get the field info used to compute the color of this treemap configuration.

Returns:
Field info used to compute the color in this treemap configuration.

getAggregationType

public LyTreemapConfiguration.Aggregation getAggregationType()
Get the aggregation type.

Parameters:
aggregation - type.

getAggregationFieldInfo

public LyFieldInfo getAggregationFieldInfo()
Get the field info used to compute aggregations in this treemap configuration.

Returns:
Field info used to compute aggregations in this treemap configuration.

getHierarchyFieldInfos

public LyInfoList<LyFieldInfo> getHierarchyFieldInfos()
Gets list of field infos of this treemap configuration.

Returns:
List of hierarchy field infos, may be null.

getHierarchyLevels

public int getHierarchyLevels()
Return the hierarchy levels for this treemap configuration.

Returns:
the hierarchy levels for this treemap configuration

isFilterActive

public boolean isFilterActive()
Indicates whether filter is active or not in this treemap configuration.

Returns:
true if filter is active, false otherwise

isFilterShowAll

public boolean isFilterShowAll()
Indicates whether filter shows all object or not in this treemap configuration.

Returns:
true if filter shows all objects, false otherwise

getMinColor

public java.lang.String getMinColor()
Get minimum color of this treemap configuration.

Returns:
The minimum color of this treemap configuration.

getMaxColor

public java.lang.String getMaxColor()
Get maximum color of this treemap configuration.

Returns:
The maximum color of this treemap configuration.

getThresholdColors

public java.lang.String[] getThresholdColors()
Get the list of threshold colors of this treemap configuration.

Returns:
The list of threshold colors of this treemap configuration.

getBorderSizes

public java.lang.String getBorderSizes()
Get border sizes of this treemap configuration.

Returns:
The border sizes of this treemap configuration.

getLabelStyles

public java.lang.String getLabelStyles()
Get label styles of this treemap configuration.

Returns:
The label styles of this treemap configuration.

getUser

public java.lang.String getUser()
Get owner of this treemap configuration.

Specified by:
getUser in interface LyExtraInfoInterface
Returns:
The owner of this treemap configuration.

setSizeFieldInfo

public void setSizeFieldInfo(LyFieldInfo sizeField)
Set the field info used to compute the sizes.

Parameters:
sizeField - Field info used to compute the sizes.

setHierarchyLevels

public void setHierarchyLevels(int hierarchyLevels)
Set the hierarchy levels.

Parameters:
hierarchyLevels - number of hierarchy levels.

setFilterActive

public void setFilterActive(boolean active)
Set the activated state for filter.

Parameters:
active - indicates whether filter is active or not.

setFilterShowAll

public void setFilterShowAll(boolean showAll)
Set the show all state for filter.

Parameters:
active - indicates whether filter shows all objects or not.

setMinColor

public void setMinColor(java.lang.String minColor)
Set the minimum color.

Parameters:
minColor - the new minimum color.

setMaxColor

public void setMaxColor(java.lang.String maxColor)
Set the maximum color.

Parameters:
minColor - the new maximum color.

setColorFieldInfo

public void setColorFieldInfo(LyFieldInfo colorField)
Set the field info used to compute the colors.

Parameters:
colorField - Field info used to compute the colors.

setAggregationType

public void setAggregationType(LyTreemapConfiguration.Aggregation aggregationType)
Set the aggregation type.

Parameters:
aggregationType - aggregation type.

setAggregationFieldInfo

public void setAggregationFieldInfo(LyFieldInfo aggregationField)
Set the field info used to compute aggregations.

Parameters:
aggregationField - Field info used to compute aggregations.

setFilter

public void setFilter(LyFilter filter)
Sets the filter used by this treemap configuration.

Parameters:
filter - the new filter.

setThresholdColors

public void setThresholdColors(java.lang.String[] colors)
Set the list of threshold colors.

Parameters:
colors - the list of threshold colors.

setBorderSizes

public void setBorderSizes(java.lang.String borderSizes)
Set the border sizes.

Parameters:
borderSizes - the new border sizes.

setLabelStyles

public void setLabelStyles(java.lang.String labelStyles)
Set the label styles.

Parameters:
labelStyles - the new label styles.

setHierarchyFieldInfos

public void setHierarchyFieldInfos(LyInfoList<LyFieldInfo> fieldInfos)
Sets list of hierarchy field infos of this treemap configuration.

Parameters:
fieldInfos - List of hierarchy field infos, may be null.

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com