Package org.compiere.model

Class Lookup

java.lang.Object
javax.swing.AbstractListModel<Object>
org.compiere.model.Lookup
All Implemented Interfaces:
Serializable, ComboBoxModel<Object>, ListModel<Object>, MutableComboBoxModel<Object>
Direct Known Subclasses:
GetListLookup, MAccountLookup, MLocationLookup, MLocatorLookup, MLookup, MPAttributeLookup, MPaymentLookup, QueryDataLookup
public abstract class Lookup extends AbstractListModel<Object> implements MutableComboBoxModel<Object>, Serializable
Base Class for MLookup, MLocator, MLocation and MAccount (only single value).
Maintains selectable data as NamePairs in ArrayList.
The objects itself may be shared by the lookup implementation (usually HashMap).
Version:
$Id: Lookup.java,v 1.3 2006/07/30 00:58:18 jjanke Exp $
Author:
Jorg Janke
See Also:

  • Field Details

  • Constructor Details

    • Lookup

      public Lookup(int displayType, int windowNo)
      Lookup
      Parameters:
      displayType - display type
      windowNo - window no

  • Method Details

    • getDisplayType

      public int getDisplayType()
      Get Display Type
      Returns:
      display type

    • getWindowNo

      public int getWindowNo()
      Get Window No
      Returns:
      Window No

    • setSelectedItem

      public void setSelectedItem(Object anObject)
      Set selected item by value. The selected item may be null.

      Specified by:
      setSelectedItem in interface ComboBoxModel<Object>
      Parameters:
      anObject - Value of selected item or null for no selection.

    • getSelectedItem

      public Object getSelectedItem()
      Return selected Item
      Specified by:
      getSelectedItem in interface ComboBoxModel<Object>
      Returns:
      value of selected item

    • getSize

      public int getSize()
      Get Size of Model
      Specified by:
      getSize in interface ListModel<Object>
      Returns:
      size

    • getElementAt

      public Object getElementAt(int index)
      Get Element at Index
      Specified by:
      getElementAt in interface ListModel<Object>
      Parameters:
      index - index
      Returns:
      value at index

    • getIndexOf

      public int getIndexOf(Object anObject)
      Returns the index-position of the specified object in the list.
      Parameters:
      anObject - object
      Returns:
      index position, where 0 is the first position

    • addElement

      public void addElement(Object anObject)
      Add Element at the end
      Specified by:
      addElement in interface MutableComboBoxModel<Object>
      Parameters:
      anObject - object

    • insertElementAt

      public void insertElementAt(Object anObject, int index)
      Insert Element At
      Specified by:
      insertElementAt in interface MutableComboBoxModel<Object>
      Parameters:
      anObject - object
      index - index

    • removeElementAt

      public void removeElementAt(int index)
      Remove Item at index
      Specified by:
      removeElementAt in interface MutableComboBoxModel<Object>
      Parameters:
      index - index

    • removeElement

      public void removeElement(Object anObject)
      Remove Item
      Specified by:
      removeElement in interface MutableComboBoxModel<Object>
      Parameters:
      anObject - object

    • removeAllElements

      public void removeAllElements()
      Empties the list.

    • put

      public void put(String key, String value)
      Append ValueNamePair to list
      Parameters:
      key - key
      value - value

    • put

      public void put(int key, String value)
      Append KeyNamePair to list
      Parameters:
      key - key
      value - value

    • fillComboBox

      public void fillComboBox(boolean mandatory, boolean onlyValidated, boolean onlyActive, boolean temporary, boolean shortList)
      Fill ComboBox with lookup data (asynchronous using Worker).
      - try to maintain selected item
      Parameters:
      mandatory - has mandatory data only (i.e. no "null" selection)
      onlyValidated - only validated
      onlyActive - onlt active
      temporary - save current values - restore via fillComboBox (true)
      shortList -

    • fillComboBox

      public void fillComboBox(boolean restore)
      Fill UI component with temporary buffered data (if exists) or load from DB
      Parameters:
      restore - if true, use temporary buffered data - else load from DB

    • getDisplay

      public abstract String getDisplay(Object key)
      Get Display Text of Key Value
      Parameters:
      key - key value
      Returns:
      Display Text

    • get

      public abstract NamePair get(Object key)
      Get NamePair of Key Value
      Parameters:
      key - key value
      Returns:
      NamePair or null

    • getData

      public abstract ArrayList<Object> getData(boolean mandatory, boolean onlyValidated, boolean onlyActive, boolean temporary, boolean shortlist)
      Load Data (Value/KeyNamePair) from DB.
      Parameters:
      mandatory - has mandatory data only (i.e. no "null" selection)
      onlyValidated - only validated
      onlyActive - only active
      temporary - force load for temporary display
      shortlist -
      Returns:
      ArrayList

    • getColumnName

      public abstract String getColumnName()
      Get underlying fully qualified Table.Column Name.
      Returns:
      column name

    • containsKey

      public abstract boolean containsKey(Object key)
      The Lookup contains the key
      Parameters:
      key - key
      Returns:
      true if contains key

    • containsKeyNoDirect

      public abstract boolean containsKeyNoDirect(Object key)
      The Lookup contains the key (do not check the direct lookup list)
      Parameters:
      key - key
      Returns:
      true if contains key

    • refresh

      public int refresh()
      Refresh Values - default implementation
      Returns:
      size

    • isValidated

      public boolean isValidated()
      Is Validated - default implementation
      Returns:
      true if validated

    • getValidation

      public String getValidation()
      Get dynamic Validation SQL (none)
      Returns:
      validation SQL

    • hasInactive

      public boolean hasInactive()
      Has Inactive records - default implementation
      Returns:
      true if has inactive records

    • getZoom

      public int getZoom()
      Get Zoom - default implementation
      Returns:
      Zoom AD_Window_ID

    • getZoom

      public int getZoom(boolean isSOTrx)
      Parameters:
      isSOTrx -
      Returns:
      Zoom AD_Window_ID

    • getZoom

      public int getZoom(MQuery query)
      Get Zoom - default implementation
      Parameters:
      query - query
      Returns:
      Zoom AD_Window_ID

    • getZoomQuery

      public MQuery getZoomQuery()
      Get Zoom Query Object
      Returns:
      Zoom Query

    • getDirect

      public NamePair getDirect(Object key, boolean saveInCache, boolean cacheLocal, String trxName)
      Perform Direct Lookup from Table.
      Parameters:
      key - key value
      saveInCache - save in cache for r/w
      cacheLocal - cache locally for r/o
      trxName - the transaction name
      Returns:
      NamePair

    • getDirect

      public NamePair getDirect(Object key, boolean saveInCache, boolean cacheLocal)
      Perform Direct Lookup from Table.
      Parameters:
      key -
      saveInCache -
      cacheLocal -
      Returns:
      NamePair

    • getDirect

      public NamePair[] getDirect(Object[] keys)
      Perform direct lookup for keys
      Parameters:
      keys -
      Returns:
      name pair arrays

    • dispose

      public void dispose()
      Dispose - clear items w/o firing events

    • loadComplete

      public void loadComplete()
      Wait until asynchronous loading complete

    • setMandatory

      public void setMandatory(boolean flag)
      Set lookup model as mandatory, use in loading data
      Parameters:
      flag -

    • isMandatory

      public boolean isMandatory()
      Is lookup model mandatory
      Returns:
      boolean

    • isLoaded

      public boolean isLoaded()
      Is this lookup model populated
      Returns:
      boolean

    • setShortList

      public void setShortList(boolean shortlist)

    • isShortList

      public boolean isShortList()
      Returns:
      true if lookup should return a short list