Package org.openxava.calculators

Class DescriptionsCalculator

  • All Implemented Interfaces:
    java.io.Serializable, ICalculator
    public class DescriptionsCalculator
extends java.lang.Object
implements ICalculator
    It obtain a description collection.

    Use tab infrastructure for it, so you can make that this execute within a EJB server or nor configuring tab in xava.properties.

    Author:
    Javier Paniza
    See Also:
    Serialized Form

    • Constructor Detail

      • DescriptionsCalculator

        public DescriptionsCalculator()

    • Method Detail

      • calculate

        public java.lang.Object calculate()
                           throws java.lang.Exception
        Pure execution, without cache...

        Better call to getDescriptions() if you wish to use directly.

        Specified by:
        calculate in interface ICalculator
        Throws:
        java.lang.Exception

      • getDescriptions

        public java.util.Collection getDescriptions()
                                     throws java.lang.Exception
        It uses cach� depend on current parameter values.

        Returns:
        Collection of KeyAndDescription. Not null.
        Throws:
        java.lang.Exception

      • getDescriptionsWithSelected

        public java.util.Collection getDescriptionsWithSelected​(java.lang.String fvalue)
                                                 throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getKeyProperty

        public java.lang.String getKeyProperty()
        It's used when there is only a key property. It's exclusive with keyProperties.

      • getDescriptionProperty

        public java.lang.String getDescriptionProperty()

      • setKeyProperty

        public void setKeyProperty​(java.lang.String keyProperty)

      • setDescriptionProperty

        public void setDescriptionProperty​(java.lang.String descriptionProperty)

      • getModel

        public java.lang.String getModel()

      • setModel

        public void setModel​(java.lang.String model)

      • getCondition

        public java.lang.String getCondition()

      • setCondition

        public void setCondition​(java.lang.String condition)

      • hasParameters

        public boolean hasParameters()

      • getParameters

        public java.util.Collection getParameters()

      • setParameters

        public void setParameters​(java.util.Collection parameters)

      • getKeyProperties

        public java.lang.String getKeyProperties()
        It's used when there are more than one property that it's key, or with only one It's preferred use a wrapper class as primary key.

        It's exclusive with keyProperties.

      • setKeyProperties

        public void setKeyProperties​(java.lang.String keyProperties)

      • isOrderByKey

        public boolean isOrderByKey()

      • setOrderByKey

        public void setOrderByKey​(boolean b)

      • setOrderByKey

        public void setOrderByKey​(java.lang.String b)

      • isUseCache

        public boolean isUseCache()

      • setUseCache

        public void setUseCache​(boolean b)

      • getDescriptionProperties

        public java.lang.String getDescriptionProperties()

      • setDescriptionProperties

        public void setDescriptionProperties​(java.lang.String string)

      • isUseConvertersInKeys

        public boolean isUseConvertersInKeys()

      • setUseConvertersInKeys

        public void setUseConvertersInKeys​(boolean b)

      • getOrder

        public java.lang.String getOrder()

      • setOrder

        public void setOrder​(java.lang.String order)

      • isDistinct

        public boolean isDistinct()
        To allow not duplicated results.
        Since:
        7.0.3

      • setDistinct

        public void setDistinct​(boolean distinct)
        To allow not duplicated results.
        Since:
        7.0.3