Package net.sf.jasperreports.properties

Interface PropertyMetadata

  • All Known Implementing Classes:
    StandardPropertyMetadata
    public interface PropertyMetadata
    Author:
    Lucian Chirita (lucianc@users.sourceforge.net)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCategory()  
      java.lang.String getConstantDeclarationClass()
      The name of the class where the property constant is declared.
      java.lang.String getConstantFieldName()
      The name of the property constant declaration (static) field.
      java.lang.String getDefaultValue()
      The default value of the property.
      java.lang.String getDescription()
      Short description of the property.
      java.lang.String getLabel()
      Short label for the property.
      java.lang.String getName()
      The property name.
      java.util.List<java.lang.String> getScopeQualifications()
      The list of conditions under which the property is used (for instance using a specific query executer).
      java.util.List<net.sf.jasperreports.annotations.properties.PropertyScope> getScopes()
      The list of scopes at which the property can be set.
      java.lang.String getSinceVersion()
      The version in which the property was introduced.
      java.lang.String getValueType()
      The type (as class name) of values that the property expects.
      boolean isDeprecated()  

    • Method Detail

      • getName

        java.lang.String getName()
        The property name.
        Returns:
        the property name

      • getCategory

        java.lang.String getCategory()

      • getConstantDeclarationClass

        java.lang.String getConstantDeclarationClass()
        The name of the class where the property constant is declared.
        Returns:
        the class name that contains the property constant declaration

      • getConstantFieldName

        java.lang.String getConstantFieldName()
        The name of the property constant declaration (static) field.
        Returns:
        the name of the property constant declaration field
        See Also:
        getConstantDeclarationClass()

      • getLabel

        java.lang.String getLabel()
        Short label for the property.
        Returns:
        short property label

      • getDescription

        java.lang.String getDescription()
        Short description of the property.
        Returns:
        short property description

      • getDefaultValue

        java.lang.String getDefaultValue()
        The default value of the property.
        Returns:
        the default property value

      • getScopes

        java.util.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

        java.util.List<java.lang.String> 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

        java.lang.String getSinceVersion()
        The version in which the property was introduced.
        Returns:
        the version in which the property was introduced

      • getValueType

        java.lang.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()