Package net.sf.jasperreports.properties
Class StandardPropertyMetadata
- java.lang.Object
-
- net.sf.jasperreports.properties.StandardPropertyMetadata
-
- All Implemented Interfaces:
PropertyMetadata
public class StandardPropertyMetadata extends Object implements PropertyMetadata
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Constructor Summary
Constructors Constructor Description StandardPropertyMetadata()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addScope(net.sf.jasperreports.annotations.properties.PropertyScope scope)
void
addScopeQualification(String scopeQualification)
String
getCategory()
String
getConstantDeclarationClass()
The name of the class where the property constant is declared.String
getConstantFieldName()
The name of the property constant declaration (static) field.String
getDefaultValue()
The default value of the property.String
getDescription()
Short description of the property.String
getLabel()
Short label for the property.String
getName()
The property name.List<String>
getScopeQualifications()
The list of conditions under which the property is used (for instance using a specific query executer).List<net.sf.jasperreports.annotations.properties.PropertyScope>
getScopes()
The list of scopes at which the property can be set.String
getSinceVersion()
The version in which the property was introduced.String
getValueType()
The type (as class name) of values that the property expects.boolean
isDeprecated()
void
setCategory(String category)
void
setConstantDeclarationClass(String constantDeclarationClass)
void
setConstantFieldName(String constantFieldName)
void
setDefaultValue(String defaultValue)
void
setDeprecated(boolean deprecated)
void
setDescription(String description)
void
setLabel(String label)
void
setName(String name)
void
setScopeQualifications(List<String> scopeQualifications)
void
setScopes(List<net.sf.jasperreports.annotations.properties.PropertyScope> scopes)
void
setSinceVersion(String sinceVersion)
void
setValueType(String valueType)
-
-
-
Method Detail
-
getLabel
public String getLabel()
Description copied from interface:PropertyMetadata
Short label for the property.- Specified by:
getLabel
in interfacePropertyMetadata
- Returns:
- short property label
-
setLabel
public void setLabel(String label)
-
getDescription
public String getDescription()
Description copied from interface:PropertyMetadata
Short description of the property.- Specified by:
getDescription
in interfacePropertyMetadata
- Returns:
- short property description
-
setDescription
public void setDescription(String description)
-
getDefaultValue
public String getDefaultValue()
Description copied from interface:PropertyMetadata
The default value of the property.- Specified by:
getDefaultValue
in interfacePropertyMetadata
- Returns:
- the default property value
-
setDefaultValue
public void setDefaultValue(String defaultValue)
-
getScopes
public List<net.sf.jasperreports.annotations.properties.PropertyScope> getScopes()
Description copied from interface:PropertyMetadata
The list of scopes at which the property can be set.- Specified by:
getScopes
in interfacePropertyMetadata
- Returns:
- the list of scopes at which the property can be set
-
setScopes
public void setScopes(List<net.sf.jasperreports.annotations.properties.PropertyScope> scopes)
-
addScope
public void addScope(net.sf.jasperreports.annotations.properties.PropertyScope scope)
-
getSinceVersion
public String getSinceVersion()
Description copied from interface:PropertyMetadata
The version in which the property was introduced.- Specified by:
getSinceVersion
in interfacePropertyMetadata
- Returns:
- the version in which the property was introduced
-
setSinceVersion
public void setSinceVersion(String sinceVersion)
-
getValueType
public String getValueType()
Description copied from interface:PropertyMetadata
The type (as class name) of values that the property expects.- Specified by:
getValueType
in interfacePropertyMetadata
- Returns:
- the type of values that the property expects
-
setValueType
public void setValueType(String valueType)
-
getName
public String getName()
Description copied from interface:PropertyMetadata
The property name.- Specified by:
getName
in interfacePropertyMetadata
- Returns:
- the property name
-
setName
public void setName(String name)
-
getConstantDeclarationClass
public String getConstantDeclarationClass()
Description copied from interface:PropertyMetadata
The name of the class where the property constant is declared.- Specified by:
getConstantDeclarationClass
in interfacePropertyMetadata
- Returns:
- the class name that contains the property constant declaration
-
setConstantDeclarationClass
public void setConstantDeclarationClass(String constantDeclarationClass)
-
getConstantFieldName
public String getConstantFieldName()
Description copied from interface:PropertyMetadata
The name of the property constant declaration (static) field.- Specified by:
getConstantFieldName
in interfacePropertyMetadata
- Returns:
- the name of the property constant declaration field
- See Also:
PropertyMetadata.getConstantDeclarationClass()
-
setConstantFieldName
public void setConstantFieldName(String constantFieldName)
-
getScopeQualifications
public List<String> getScopeQualifications()
Description copied from interface:PropertyMetadata
The list of conditions under which the property is used (for instance using a specific query executer).- Specified by:
getScopeQualifications
in interfacePropertyMetadata
- Returns:
- the list of conditions under which the property is used
-
addScopeQualification
public void addScopeQualification(String scopeQualification)
-
getCategory
public String getCategory()
- Specified by:
getCategory
in interfacePropertyMetadata
-
setCategory
public void setCategory(String category)
-
isDeprecated
public boolean isDeprecated()
- Specified by:
isDeprecated
in interfacePropertyMetadata
-
setDeprecated
public void setDeprecated(boolean deprecated)
-
-