Class ConfigDescriptionEntry
- java.lang.Object
-
- org.pentaho.reporting.tools.configeditor.model.ConfigDescriptionEntry
-
- Direct Known Subclasses:
ClassConfigDescriptionEntry
,EnumConfigDescriptionEntry
,TextConfigDescriptionEntry
public abstract class ConfigDescriptionEntry extends Object
A config description entry provides a declaration of a single report configuration key and speicifes rules for the values of that key.- Author:
- Thomas Morgner
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ConfigDescriptionEntry(String keyName)
Creates a new config description entry with the given name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
Checks whether the given object is equal to this config description entry.String
getDescription()
Returns the descrption of the configuration entry.String
getKeyName()
Returns the full key name of the configuration description.int
hashCode()
Computes an hashcode for this object.boolean
isGlobal()
Returns, whether the key is a global key.boolean
isHidden()
Returns, whether the key is hidden.void
setDescription(String description)
Defines the descrption of the configuration entry.void
setGlobal(boolean global)
Defines, whether the key is a global key.void
setHidden(boolean hidden)
Defines, whether the key is hidden.
-
-
-
Constructor Detail
-
ConfigDescriptionEntry
protected ConfigDescriptionEntry(String keyName)
Creates a new config description entry with the given name.- Parameters:
keyName
- the name of the entry.
-
-
Method Detail
-
getKeyName
public String getKeyName()
Returns the full key name of the configuration description.- Returns:
- the key name.
-
getDescription
public String getDescription()
Returns the descrption of the configuration entry.- Returns:
- the key description.
-
setDescription
public void setDescription(String description)
Defines the descrption of the configuration entry.- Parameters:
description
- the key description.
-
isGlobal
public boolean isGlobal()
Returns, whether the key is a global key. Global keys are read from the global report configuration and specifying them in the report local configuration is useless.- Returns:
- true, if the key is global, false otherwise.
-
setGlobal
public void setGlobal(boolean global)
Defines, whether the key is a global key. Global keys are read from the global report configuration and specifying them in the report local configuration is useless.- Parameters:
global
- set to true, if the key is global, false otherwise.
-
isHidden
public boolean isHidden()
Returns, whether the key is hidden. Hidden keys will not be visible in the configuration editor.- Returns:
- true, if the key is hidden, false otherwise
-
setHidden
public void setHidden(boolean hidden)
Defines, whether the key is hidden. Hidden keys will not be visible in the configuration editor.- Parameters:
hidden
- set to true, if the key is hidden, false otherwise
-
equals
public boolean equals(Object o)
Checks whether the given object is equal to this config description entry. The object will be equal, if it is also an config description entry with the same name as this entry.- Overrides:
equals
in classObject
- Parameters:
o
- the other object.- Returns:
- true, if the config entry is equal to the given object, false otherwise.
- See Also:
Object.equals(Object)
-
hashCode
public int hashCode()
Computes an hashcode for this object.- Overrides:
hashCode
in classObject
- Returns:
- the hashcode.
- See Also:
Object.hashCode()
-
-