Package net.sf.jasperreports.properties
Interface PropertyMetadata
- All Known Implementing Classes:
StandardPropertyMetadata
public interface PropertyMetadata
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the class where the property constant is declared.The name of the property constant declaration (static) field.The default value of the property.Short description of the property.getLabel()
Short label for the property.getName()
The property name.The list of conditions under which the property is used (for instance using a specific query executer).List
<net.sf.jasperreports.annotations.properties.PropertyScope> The list of scopes at which the property can be set.The version in which the property was introduced.The type (as class name) of values that the property expects.boolean
-
Method Details
-
getName
String getName()The property name.- Returns:
- the property name
-
getCategory
String getCategory() -
getConstantDeclarationClass
String getConstantDeclarationClass()The name of the class where the property constant is declared.- Returns:
- the class name that contains the property constant declaration
-
getConstantFieldName
String getConstantFieldName()The name of the property constant declaration (static) field.- Returns:
- the name of the property constant declaration field
- See Also:
-
getLabel
String getLabel()Short label for the property.- Returns:
- short property label
-
getDescription
String getDescription()Short description of the property.- Returns:
- short property description
-
getDefaultValue
String getDefaultValue()The default value of the property.- Returns:
- the default property value
-
getScopes
List<net.sf.jasperreports.annotations.properties.PropertyScope> getScopes()The list of scopes at which the property can be set.- Returns:
- the list of scopes at which the property can be set
-
getScopeQualifications
The list of conditions under which the property is used (for instance using a specific query executer).- Returns:
- the list of conditions under which the property is used
-
getSinceVersion
String getSinceVersion()The version in which the property was introduced.- Returns:
- the version in which the property was introduced
-
getValueType
String getValueType()The type (as class name) of values that the property expects.- Returns:
- the type of values that the property expects
-
isDeprecated
boolean isDeprecated()
-