Class StandardPropertyMetadata

  • All Implemented Interfaces:
    PropertyMetadata

    public class StandardPropertyMetadata
    extends java.lang.Object
    implements PropertyMetadata
    Author:
    Lucian Chirita (lucianc@users.sourceforge.net)
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addScope​(net.sf.jasperreports.annotations.properties.PropertyScope scope)  
      void addScopeQualification​(java.lang.String scopeQualification)  
      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()  
      void setCategory​(java.lang.String category)  
      void setConstantDeclarationClass​(java.lang.String constantDeclarationClass)  
      void setConstantFieldName​(java.lang.String constantFieldName)  
      void setDefaultValue​(java.lang.String defaultValue)  
      void setDeprecated​(boolean deprecated)  
      void setDescription​(java.lang.String description)  
      void setLabel​(java.lang.String label)  
      void setName​(java.lang.String name)  
      void setScopeQualifications​(java.util.List<java.lang.String> scopeQualifications)  
      void setScopes​(java.util.List<net.sf.jasperreports.annotations.properties.PropertyScope> scopes)  
      void setSinceVersion​(java.lang.String sinceVersion)  
      void setValueType​(java.lang.String valueType)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StandardPropertyMetadata

        public StandardPropertyMetadata()
    • Method Detail

      • getLabel

        public java.lang.String getLabel()
        Description copied from interface: PropertyMetadata
        Short label for the property.
        Specified by:
        getLabel in interface PropertyMetadata
        Returns:
        short property label
      • setLabel

        public void setLabel​(java.lang.String label)
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: PropertyMetadata
        Short description of the property.
        Specified by:
        getDescription in interface PropertyMetadata
        Returns:
        short property description
      • setDescription

        public void setDescription​(java.lang.String description)
      • getDefaultValue

        public java.lang.String getDefaultValue()
        Description copied from interface: PropertyMetadata
        The default value of the property.
        Specified by:
        getDefaultValue in interface PropertyMetadata
        Returns:
        the default property value
      • setDefaultValue

        public void setDefaultValue​(java.lang.String defaultValue)
      • getScopes

        public java.util.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 interface PropertyMetadata
        Returns:
        the list of scopes at which the property can be set
      • setScopes

        public void setScopes​(java.util.List<net.sf.jasperreports.annotations.properties.PropertyScope> scopes)
      • addScope

        public void addScope​(net.sf.jasperreports.annotations.properties.PropertyScope scope)
      • getSinceVersion

        public java.lang.String getSinceVersion()
        Description copied from interface: PropertyMetadata
        The version in which the property was introduced.
        Specified by:
        getSinceVersion in interface PropertyMetadata
        Returns:
        the version in which the property was introduced
      • setSinceVersion

        public void setSinceVersion​(java.lang.String sinceVersion)
      • getValueType

        public java.lang.String getValueType()
        Description copied from interface: PropertyMetadata
        The type (as class name) of values that the property expects.
        Specified by:
        getValueType in interface PropertyMetadata
        Returns:
        the type of values that the property expects
      • setValueType

        public void setValueType​(java.lang.String valueType)
      • getName

        public java.lang.String getName()
        Description copied from interface: PropertyMetadata
        The property name.
        Specified by:
        getName in interface PropertyMetadata
        Returns:
        the property name
      • setName

        public void setName​(java.lang.String name)
      • getConstantDeclarationClass

        public java.lang.String getConstantDeclarationClass()
        Description copied from interface: PropertyMetadata
        The name of the class where the property constant is declared.
        Specified by:
        getConstantDeclarationClass in interface PropertyMetadata
        Returns:
        the class name that contains the property constant declaration
      • setConstantDeclarationClass

        public void setConstantDeclarationClass​(java.lang.String constantDeclarationClass)
      • setConstantFieldName

        public void setConstantFieldName​(java.lang.String constantFieldName)
      • getScopeQualifications

        public java.util.List<java.lang.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 interface PropertyMetadata
        Returns:
        the list of conditions under which the property is used
      • setScopeQualifications

        public void setScopeQualifications​(java.util.List<java.lang.String> scopeQualifications)
      • addScopeQualification

        public void addScopeQualification​(java.lang.String scopeQualification)
      • setCategory

        public void setCategory​(java.lang.String category)
      • setDeprecated

        public void setDeprecated​(boolean deprecated)