Java Doc for DefaultPrimaryKeyEncoder.java in  » Library » Tapestry » org » apache » tapestry » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » Tapestry » org.apache.tapestry.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.tapestry.util.DefaultPrimaryKeyEncoder

DefaultPrimaryKeyEncoder
public class DefaultPrimaryKeyEncoder implements PrimaryKeyEncoder<K, V>(Code)
A default, extensible version of PrimaryKeyEncoder that is based on loading known values into an internal map. When there's a reasonable number (hundreds, perhaps thousands) of items to choose from, and those items are fast and cheap to read and instantiate, this implementation is a good bet. For very large result sets, you'll need to create your own implementation of PrimaryKeyEncoder . <
Parameters:
  K - >the key type (which must be serializable)<
Parameters:
  V - >the value type




Method Summary
final public  voidadd(K key, V value)
     Adds a new key/value pair to the encoder.
final public  List<V>getAllValues()
    
final public  List<V>getValues()
     Returns the values previously DefaultPrimaryKeyEncoder.add(Serializable,Object) added to the encoder , in the order in which they were added.
final protected  booleaninKeySet(Set<K> keySet)
     Returns true if the current key is in the provided set.
final public  booleanisDeleted()
    
final protected  Set<K>modifyKeySet(Set<K> keySet, boolean value)
     Modifies a keySet to add or remove the current key.
public  voidprepareForKeys(List<K> keys)
     Does nothing.
protected  VprovideMissingObject(K key)
     Invoked by DefaultPrimaryKeyEncoder.toValue(Serializable) whenever a key can not be converted to a value using the internal cache.
final public  voidsetDeleted(boolean value)
    
final public  KtoKey(V value)
     For a previously DefaultPrimaryKeyEncoder.add(Serializable,Object) added key/value pair , returns the key corresponding to the given value.
final public  VtoValue(K key)
    
final protected  List<V>valuesNotInKeySet(Set<K> keySet)
     Returns a list of all the values except those values whose keys are in the provided set.



Method Detail
add
final public void add(K key, V value)(Code)
Adds a new key/value pair to the encoder.



getAllValues
final public List<V> getAllValues()(Code)



getValues
final public List<V> getValues()(Code)
Returns the values previously DefaultPrimaryKeyEncoder.add(Serializable,Object) added to the encoder , in the order in which they were added. Values that are deleted are not returned. ordered list of values



inKeySet
final protected boolean inKeySet(Set<K> keySet)(Code)
Returns true if the current key is in the provided set.
Parameters:
  keySet - the set of keys to check, or null true if the key is in the set, false if it is missing (or if keySet is null)



isDeleted
final public boolean isDeleted()(Code)



modifyKeySet
final protected Set<K> modifyKeySet(Set<K> keySet, boolean value)(Code)
Modifies a keySet to add or remove the current key. If necessary, a new Set is created.

Useage: private Set _myFlagKeys; public boolean void setMyFlag(boolean value) { _myFlagKeys = modifySet(_myFlagKeys, value); }
Parameters:
  keySet - the set of keys, or null
Parameters:
  value - true to add the current key, false to remove the provided key set, or a new one




prepareForKeys
public void prepareForKeys(List<K> keys)(Code)
Does nothing. Subclasses may override as necessary.



provideMissingObject
protected V provideMissingObject(K key)(Code)
Invoked by DefaultPrimaryKeyEncoder.toValue(Serializable) whenever a key can not be converted to a value using the internal cache. This is an opportunity to record the fact that an error occured (they key was not valuable, possibly because it points to a deleted entity object) and provide a temporary object. This method may return null, but in a typical application, that will likely case NullPointerExceptions further down the processing chain.

This implementation returns null, and is intended to be overriden in subclasses.
Parameters:
  key - key for which a value is required a substitute value, or null




setDeleted
final public void setDeleted(boolean value)(Code)



toKey
final public K toKey(V value)(Code)
For a previously DefaultPrimaryKeyEncoder.add(Serializable,Object) added key/value pair , returns the key corresponding to the given value.



toValue
final public V toValue(K key)(Code)



valuesNotInKeySet
final protected List<V> valuesNotInKeySet(Set<K> keySet)(Code)
Returns a list of all the values except those values whose keys are in the provided set. The set may be null, in which case all values are returned.
Parameters:
  keySet - set of keys identifying values to exclude, or null to exclude no values values (not in the set) in order origionally added



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.