org.tbee.swing.jpa
Class JpaEntitySearchBuilder<T>

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.tbee.swing.jpa.JpaEntitySearchBuilder<T>

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JpaEntitySearchBuilder<T>
extends JPanel

See Also:

Serialized Form

Nested Class Summary

static interface	JpaEntitySearchBuilder.JpaEntitySearchBuilderToggler
static class	JpaEntitySearchBuilder.JPQL
static class	JpaEntitySearchBuilder.Parameter
class	JpaEntitySearchBuilder.SearchableField
static interface	JpaEntitySearchBuilder.SearchFeedbackListener
static class	JpaEntitySearchBuilder.SearchFeedbackListenerImpl

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

JpaEntitySearchBuilder(Class entityClass, String prefix, String path)

Method Summary

void	appendToWhereclause(String value) append a part to the whereclause.
void	clear() clear all search fields
void	clearOrDefault() clear all search fields
void	clearOrDefaultSearchFields() clear all search fields
void	clearSearchFields() clear all search fields
void	clearWhereclauseAndParameters() clears both the whereclause and its parameters
Object	convertStringToStandardTypes(String s, Class c)
protected JpaEntitySearchBuilder.SearchableField	createLinkedField(String linkedField, String[] linkedFieldTokens, int idx)
JPanel	createSearchPanel(JpaEntitySearchBuilder.SearchFeedbackListener startSearchListener, nl.knowledgeplaza.util.ValueHolder<List<T>> foundEntitiesValueHolder) Create the search panel
protected void	determineLabels()
protected void	determineLinkedFields()
protected void	determinePropertyNames()
protected void	determineSearchableFields()
static Class	getCustomBuilder(Class entityClass)
Class	getEntityClass() EntityClass
static List<Field>	getIdFields(Class clazz)
static List<String>	getLinkedFields(Class entityClass)
static List<String>	getMoveToTop(String path)
String	getPath() Path
String	getPathForConfig()
String	getPrefix() Prefix
javax.persistence.Query	getQuery()
static JpaEntitySearchComponentFactory	getSearchComponentFactory(Class entityClass, String fieldName)
static List<String>	getUnfold(String path)
String	getWhereclause() Whereclause; <*> is replaced with the current active entity id
List<JpaEntitySearchBuilder.Parameter>	getWhereclauseParameters()
static JpaEntitySearchBuilder	newJpaEntitySearchBuilder(Class c, String prefix)
protected static JpaEntitySearchBuilder	newJpaEntitySearchBuilder(Class c, String prefix, String path) For overriding when extending this class
static JpaEntitySearchBuilder	obtainJpaEntitySearchBuilder(Class c, String prefix)
static JpaEntitySearchBuilder	obtainJpaEntitySearchBuilder(Class c, String prefix, String path) get a cached one, or create one
static void	prepareJpaEntitySearchBuilder(Class c, String prefix)
static void	prepareJpaEntitySearchBuilder(Class c, String prefix, String path) If not present, prepare one and place in cache
static void	returnJpaEntitySearchBuilder(JpaEntitySearchBuilder jpaEntitySearchBuilder) return to cache
protected List<T>	search(List<T> current, List<T> queryResult)
protected List<T>	searchAddToResult(List<T> current, List<T> queryResult)
protected List<T>	searchDialog(Component component, String title, int selectMode, List<T> returnSearchResult) Open a search dialog that returns a list of entities
protected List<T>	searchInResult(List<T> current, List<T> queryResult)
List<T>	searchMultipleDialog(Component component, String title) Open a search dialog that returns a list of entities
protected List<T>	searchRemoveFromResult(List<T> current, List<T> queryResult)
T	searchSingleDialog(Component component, String title) Open a search dialog that returns one entity or null
T	searchSingleDialog(Component component, String title, List<T> returnSearchResult) Special for filtering: Open a search dialog that returns one entity or null AND the complete search result set
static void	setCustomBuilder(Class entityClass, Class searchClass) custom builders
void	setEntityClass(Class value)
static void	setLinkedFields(Class entityClass, String... propertyNames) LinkedFields
static void	setMoveToTop(Class entityClass, String... propertyNames) MoveToTop
static void	setMoveToTop(String path, String... propertyNames)
protected void	setPath(String value)
void	setPrefix(String value)
static void	setSearchComponentFactory(Class entityClass, String fieldName, JpaEntitySearchComponentFactory searchComponentFactory) SearchComponent
static void	setUnfold(Class clazz, String... propertyNames)
static void	setUnfold(String path, String... propertyNames) Unfold
protected void	setupGui()
void	setWhereclause(String value)
void	setWhereclauseParameter(JpaEntitySearchBuilder.Parameter parameter)
void	setWhereclauseParameter(String name, Object value) whereclause parameters
void	unfold(String pathToUnfold)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JpaEntitySearchBuilder

public JpaEntitySearchBuilder(Class entityClass,
                              String prefix,
                              String path)

Method Detail

obtainJpaEntitySearchBuilder

public static JpaEntitySearchBuilder obtainJpaEntitySearchBuilder(Class c,
                                                                  String prefix,
                                                                  String path)

get a cached one, or create one

obtainJpaEntitySearchBuilder

public static JpaEntitySearchBuilder obtainJpaEntitySearchBuilder(Class c,
                                                                  String prefix)

returnJpaEntitySearchBuilder

public static void returnJpaEntitySearchBuilder(JpaEntitySearchBuilder jpaEntitySearchBuilder)

return to cache

Parameters:

jpaEntitySearchBuilder -

prepareJpaEntitySearchBuilder

public static void prepareJpaEntitySearchBuilder(Class c,
                                                 String prefix,
                                                 String path)

If not present, prepare one and place in cache

Parameters:

c -

prefix -

prepareJpaEntitySearchBuilder

public static void prepareJpaEntitySearchBuilder(Class c,
                                                 String prefix)

setCustomBuilder

public static void setCustomBuilder(Class entityClass,
                                    Class searchClass)

custom builders

getCustomBuilder

public static Class getCustomBuilder(Class entityClass)

newJpaEntitySearchBuilder

protected static JpaEntitySearchBuilder newJpaEntitySearchBuilder(Class c,
                                                                  String prefix,
                                                                  String path)

For overriding when extending this class

Parameters:

c -

Returns:

newJpaEntitySearchBuilder

public static JpaEntitySearchBuilder newJpaEntitySearchBuilder(Class c,
                                                               String prefix)

setLinkedFields

public static void setLinkedFields(Class entityClass,
                                   String... propertyNames)

LinkedFields

getLinkedFields

public static List<String> getLinkedFields(Class entityClass)

setMoveToTop

public static void setMoveToTop(Class entityClass,
                                String... propertyNames)

MoveToTop

setMoveToTop

public static void setMoveToTop(String path,
                                String... propertyNames)

getMoveToTop

public static List<String> getMoveToTop(String path)

setUnfold

public static void setUnfold(String path,
                             String... propertyNames)

Unfold

setUnfold

public static void setUnfold(Class clazz,
                             String... propertyNames)

getUnfold

public static List<String> getUnfold(String path)

getEntityClass

public Class getEntityClass()

EntityClass

setEntityClass

public void setEntityClass(Class value)

getPrefix

public String getPrefix()

Prefix

setPrefix

public void setPrefix(String value)

getPath

public String getPath()

Path

setPath

protected void setPath(String value)

getPathForConfig

public String getPathForConfig()

getWhereclause

public String getWhereclause()

Whereclause; <*> is replaced with the current active entity id

setWhereclause

public void setWhereclause(String value)

appendToWhereclause

public void appendToWhereclause(String value)

append a part to the whereclause. BEWARE: an 'and' is prefix automatically if appropriate. <*> is replaced with the current active entity id

setWhereclauseParameter

public void setWhereclauseParameter(String name,
                                    Object value)

whereclause parameters

setWhereclauseParameter

public void setWhereclauseParameter(JpaEntitySearchBuilder.Parameter parameter)

getWhereclauseParameters

public List<JpaEntitySearchBuilder.Parameter> getWhereclauseParameters()

clearWhereclauseAndParameters

public void clearWhereclauseAndParameters()

clears both the whereclause and its parameters

setSearchComponentFactory

public static void setSearchComponentFactory(Class entityClass,
                                             String fieldName,
                                             JpaEntitySearchComponentFactory searchComponentFactory)

SearchComponent

getSearchComponentFactory

public static JpaEntitySearchComponentFactory getSearchComponentFactory(Class entityClass,
                                                                        String fieldName)

determineSearchableFields

protected void determineSearchableFields()

determineLinkedFields

protected void determineLinkedFields()

createLinkedField

protected JpaEntitySearchBuilder.SearchableField createLinkedField(String linkedField,
                                                                   String[] linkedFieldTokens,
                                                                   int idx)

determinePropertyNames

protected void determinePropertyNames()

determineLabels

protected void determineLabels()

setupGui

protected void setupGui()

unfold

public void unfold(String pathToUnfold)

Parameters:

pathToUnfold -

clear

public void clear()

clear all search fields

clearSearchFields

public void clearSearchFields()

clear all search fields

clearOrDefault

public void clearOrDefault()

clear all search fields

clearOrDefaultSearchFields

public void clearOrDefaultSearchFields()

clear all search fields

getQuery

public javax.persistence.Query getQuery()

convertStringToStandardTypes

public Object convertStringToStandardTypes(String s,
                                           Class c)

Parameters:

s -

c -

Returns:

getIdFields

public static List<Field> getIdFields(Class clazz)

Parameters:

clazz -

name -

Returns:

searchSingleDialog

public T searchSingleDialog(Component component,
                            String title,
                            List<T> returnSearchResult)

Special for filtering: Open a search dialog that returns one entity or null AND the complete search result set

searchSingleDialog

public T searchSingleDialog(Component component,
                            String title)

Open a search dialog that returns one entity or null

searchMultipleDialog

public List<T> searchMultipleDialog(Component component,
                                    String title)

Open a search dialog that returns a list of entities

searchDialog

protected List<T> searchDialog(Component component,
                               String title,
                               int selectMode,
                               List<T> returnSearchResult)

Open a search dialog that returns a list of entities

createSearchPanel

public JPanel createSearchPanel(JpaEntitySearchBuilder.SearchFeedbackListener startSearchListener,
                                nl.knowledgeplaza.util.ValueHolder<List<T>> foundEntitiesValueHolder)

Create the search panel

search

protected List<T> search(List<T> current,
                         List<T> queryResult)

searchInResult

protected List<T> searchInResult(List<T> current,
                                 List<T> queryResult)

searchRemoveFromResult

protected List<T> searchRemoveFromResult(List<T> current,
                                         List<T> queryResult)

searchAddToResult

protected List<T> searchAddToResult(List<T> current,
                                    List<T> queryResult)