Package org.openxava.calculators

Class DescriptionsCalculator

java.lang.Object
org.openxava.calculators.DescriptionsCalculator
All Implemented Interfaces:
Serializable, ICalculator
public class DescriptionsCalculator extends 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:

  • Constructor Details

    • DescriptionsCalculator

      public DescriptionsCalculator()

  • Method Details

    • calculate

      public Object calculate() throws Exception
      Implementation of ICalculator interface. Uses the new paginated approach for compatibility.
      Specified by:
      calculate in interface ICalculator
      Throws:
      Exception

    • getDescriptions

      public Collection<KeyAndDescription> getDescriptions() throws Exception
      Returns descriptions using on-demand loading with a default pagination window.
      Returns:
      Collection of KeyAndDescription. Not null.
      Throws:
      Exception

    • getDescriptions

      public Collection<KeyAndDescription> getDescriptions(int limit, int offset) throws Exception
      Returns a paginated collection of descriptions with database-level LIMIT and OFFSET. This method bypasses cache to ensure fresh data for pagination.
      Parameters:
      limit - Maximum number of records to return
      offset - Number of records to skip
      Returns:
      Collection of KeyAndDescription. Not null.
      Throws:
      Exception
      Since:
      7.6

    • getDescriptions

      public Collection<KeyAndDescription> getDescriptions(int limit, int offset, String searchTerm) throws Exception
      Returns a paginated collection of descriptions with database-level LIMIT and OFFSET. This method bypasses cache to ensure fresh data for pagination.
      Parameters:
      limit - Maximum number of records to return
      offset - Number of records to skip
      searchTerm - Term to search for in description properties
      Returns:
      Collection of KeyAndDescription objects matching the search term
      Throws:
      Exception - if there's an error executing the query

    • getDescriptionsCount

      public int getDescriptionsCount() throws Exception
      Returns the total count of descriptions without loading the actual data. Used to determine if remote mode should be activated.
      Returns:
      Total count of descriptions
      Throws:
      Exception
      Since:
      7.6

    • findDescriptionByKey

      public KeyAndDescription findDescriptionByKey(Object key) throws Exception
      Finds a specific description by key without loading all data. Used in remote mode to get the selected item description.
      Parameters:
      key - The key to search for
      Returns:
      KeyAndDescription if found, null otherwise
      Throws:
      Exception
      Since:
      7.6

    • getDescriptionsWithSelected

      public Collection<KeyAndDescription> getDescriptionsWithSelected(String fvalue) throws Exception
      Throws:
      Exception

    • getKeyProperty

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

    • getDescriptionProperty

      public String getDescriptionProperty()

    • setKeyProperty

      public void setKeyProperty(String keyProperty)

    • setDescriptionProperty

      public void setDescriptionProperty(String descriptionProperty)

    • getModel

      public String getModel()

    • setModel

      public void setModel(String model)

    • getCondition

      public String getCondition()

    • setCondition

      public void setCondition(String condition)

    • hasParameters

      public boolean hasParameters()

    • getParameters

      public Collection<?> getParameters()

    • setParameters

      public void setParameters(Collection<?> parameters)

    • setParameters

      public void setParameters(Collection<?> parameters, IFilter filter) throws FilterException
      Throws:
      FilterException

    • getKeyProperties

      public 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(String keyProperties)

    • isOrderByKey

      public boolean isOrderByKey()

    • setOrderByKey

      public void setOrderByKey(boolean b)

    • setOrderByKey

      public void setOrderByKey(String b)

    • getDescriptionProperties

      public String getDescriptionProperties()

    • setDescriptionProperties

      public void setDescriptionProperties(String string)

    • isUseConvertersInKeys

      public boolean isUseConvertersInKeys()

    • setUseConvertersInKeys

      public void setUseConvertersInKeys(boolean b)

    • getOrder

      public String getOrder()

    • setOrder

      public void setOrder(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