Java Doc for DataView.java in  » JMX » je » com » sleepycat » collections » 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 » JMX » je » com.sleepycat.collections 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sleepycat.collections.DataView

DataView
final class DataView implements Cloneable(Code)
Represents a Berkeley DB database and adds support for indices, bindings and key ranges.

This class defines a view and takes care of reading and updating indices, calling bindings, constraining access to a key range, etc.


author:
   Mark Hayes


Field Summary
 booleanbtreeRecNumAccess
    
 booleanbtreeRecNumDb
    
 CurrentTransactioncurrentTxn
    
 CursorConfigcursorConfig
    
 Databasedb
    
 booleandupsAllowed
    
 DatabaseEntrydupsKey
    
 booleandupsOrdered
    
 KeyRangedupsRange
    
 booleandupsView
    
 EntityBindingentityBinding
    
 PrimaryKeyAssignerkeyAssigner
    
 EntryBindingkeyBinding
    
 booleankeysRenumbered
    
 booleanordered
    
 KeyRangerange
    
 booleanreadUncommittedAllowed
    
 booleanrecNumAccess
    
 booleanrecNumAllowed
    
 booleanrecNumRenumber
    
 SecondaryDatabasesecDb
    
 SecondaryKeyCreatorsecKeyCreator
    
 booleantransactional
    
 EntryBindingvalueBinding
    
 booleanwriteAllowed
    

Constructor Summary
 DataView(Database database, EntryBinding keyBinding, EntryBinding valueBinding, EntityBinding entityBinding, boolean writeAllowed, PrimaryKeyAssigner keyAssigner)
     Creates a view for a given database and bindings.

Method Summary
 OperationStatusappend(Object value, Object[] retPrimaryKey, Object[] retValue)
     Appends a value and returns the new key.
final  booleancanDeriveKeyFromValue()
     Returns whether data keys can be derived from the value/entity binding of this view, which determines whether a value/entity object alone is sufficient for operations that require keys.
 voidclear()
     Deletes all records in the current range.
 DataViewconfiguredView(CursorConfig config)
     Returns a new view with a specified cursor configuration.
 DataViewduplicatesView(Object secondaryKey, EntryBinding primaryKeyBinding)
     Return a new duplicates view for a given secondary key.
 CurrentTransactiongetCurrentTxn()
     Returns the current transaction for the view or null if the environment is non-transactional.
final  EnvironmentgetEnv()
     Returns the environment for the database.
 DatabaseEntrygetSingleKeyThang()
     Returns the key thang for a single key range, or null if a single key range is not used.
 booleanisEmpty()
     Returns whether no records are present in the view.
final  booleanisSecondary()
     Returns whether this is a view on a secondary database rather than directly on a primary database.
 DataCursorjoin(DataView[] indexViews, Object[] indexKeys, JoinConfig joinConfig)
     Returns a cursor for this view that reads only records having the specified index key values.
 DataCursorjoin(DataCursor[] indexCursors, JoinConfig joinConfig)
     Returns a cursor for this view that reads only records having the index key values at the specified cursors.
 DataViewkeySetView()
     Return a new key-set view derived from this view by setting the entity and value binding to null.
 ObjectmakeKey(DatabaseEntry keyThang, DatabaseEntry priKeyThang)
     Converts a key entry to a key object.
 ObjectmakeValue(DatabaseEntry primaryKeyThang, DatabaseEntry valueThang)
     Converts a key-value entry pair to a value object.
 KeyRangesubRange(KeyRange useRange, Object singleKey)
     Intersects the given key and the current range.
 KeyRangesubRange(KeyRange useRange, Object beginKey, boolean beginInclusive, Object endKey, boolean endInclusive)
     Intersects the given range and the current range.
 DataViewsubView(Object beginKey, boolean beginInclusive, Object endKey, boolean endInclusive, EntryBinding keyBinding)
     Return a new value-set view for key range, optionally changing the key binding.
 booleanuseKey(Object key, Object value, DatabaseEntry keyThang, KeyRange checkRange)
     Populates the key entry and returns whether the key is within range.
 KeyRangeuseSubRange()
     Returns the range to use for sub-ranges.
 TransactionuseTransaction()
     Returns the current transaction if the database is transaction, or null if the database is not transactional or there is no current transaction.
 voiduseValue(Object value, DatabaseEntry valueThang, DatabaseEntry checkKeyThang)
     Populates the value entry and throws an exception if the primary key would be changed via an entity binding.
 DataViewvalueSetView()
     Return a new value-set view derived from this view by setting the key binding to null.
 DataViewvalueSetView(Object singleKey)
     Return a new value-set view for single key range.
Parameters:
  singleKey - the single key value.

Field Detail
btreeRecNumAccess
boolean btreeRecNumAccess(Code)



btreeRecNumDb
boolean btreeRecNumDb(Code)



currentTxn
CurrentTransaction currentTxn(Code)



cursorConfig
CursorConfig cursorConfig(Code)



db
Database db(Code)



dupsAllowed
boolean dupsAllowed(Code)



dupsKey
DatabaseEntry dupsKey(Code)



dupsOrdered
boolean dupsOrdered(Code)



dupsRange
KeyRange dupsRange(Code)



dupsView
boolean dupsView(Code)



entityBinding
EntityBinding entityBinding(Code)



keyAssigner
PrimaryKeyAssigner keyAssigner(Code)



keyBinding
EntryBinding keyBinding(Code)



keysRenumbered
boolean keysRenumbered(Code)



ordered
boolean ordered(Code)



range
KeyRange range(Code)



readUncommittedAllowed
boolean readUncommittedAllowed(Code)



recNumAccess
boolean recNumAccess(Code)



recNumAllowed
boolean recNumAllowed(Code)



recNumRenumber
boolean recNumRenumber(Code)



secDb
SecondaryDatabase secDb(Code)



secKeyCreator
SecondaryKeyCreator secKeyCreator(Code)



transactional
boolean transactional(Code)



valueBinding
EntryBinding valueBinding(Code)



writeAllowed
boolean writeAllowed(Code)




Constructor Detail
DataView
DataView(Database database, EntryBinding keyBinding, EntryBinding valueBinding, EntityBinding entityBinding, boolean writeAllowed, PrimaryKeyAssigner keyAssigner) throws IllegalArgumentException(Code)
Creates a view for a given database and bindings. The initial key range of the view will be open.




Method Detail
append
OperationStatus append(Object value, Object[] retPrimaryKey, Object[] retValue) throws DatabaseException(Code)
Appends a value and returns the new key. If a key assigner is used it assigns the key, otherwise a QUEUE or RECNO database is required.



canDeriveKeyFromValue
final boolean canDeriveKeyFromValue()(Code)
Returns whether data keys can be derived from the value/entity binding of this view, which determines whether a value/entity object alone is sufficient for operations that require keys.



clear
void clear() throws DatabaseException(Code)
Deletes all records in the current range.



configuredView
DataView configuredView(CursorConfig config)(Code)
Returns a new view with a specified cursor configuration.



duplicatesView
DataView duplicatesView(Object secondaryKey, EntryBinding primaryKeyBinding) throws DatabaseException, KeyRangeException(Code)
Return a new duplicates view for a given secondary key.



getCurrentTxn
CurrentTransaction getCurrentTxn()(Code)
Returns the current transaction for the view or null if the environment is non-transactional.



getEnv
final Environment getEnv()(Code)
Returns the environment for the database.



getSingleKeyThang
DatabaseEntry getSingleKeyThang()(Code)
Returns the key thang for a single key range, or null if a single key range is not used.



isEmpty
boolean isEmpty() throws DatabaseException(Code)
Returns whether no records are present in the view.



isSecondary
final boolean isSecondary()(Code)
Returns whether this is a view on a secondary database rather than directly on a primary database.



join
DataCursor join(DataView[] indexViews, Object[] indexKeys, JoinConfig joinConfig) throws DatabaseException(Code)
Returns a cursor for this view that reads only records having the specified index key values.



join
DataCursor join(DataCursor[] indexCursors, JoinConfig joinConfig) throws DatabaseException(Code)
Returns a cursor for this view that reads only records having the index key values at the specified cursors.



keySetView
DataView keySetView()(Code)
Return a new key-set view derived from this view by setting the entity and value binding to null. the derived view.



makeKey
Object makeKey(DatabaseEntry keyThang, DatabaseEntry priKeyThang)(Code)
Converts a key entry to a key object.



makeValue
Object makeValue(DatabaseEntry primaryKeyThang, DatabaseEntry valueThang)(Code)
Converts a key-value entry pair to a value object.



subRange
KeyRange subRange(KeyRange useRange, Object singleKey) throws DatabaseException, KeyRangeException(Code)
Intersects the given key and the current range.



subRange
KeyRange subRange(KeyRange useRange, Object beginKey, boolean beginInclusive, Object endKey, boolean endInclusive) throws DatabaseException, KeyRangeException(Code)
Intersects the given range and the current range.



subView
DataView subView(Object beginKey, boolean beginInclusive, Object endKey, boolean endInclusive, EntryBinding keyBinding) throws DatabaseException, KeyRangeException(Code)
Return a new value-set view for key range, optionally changing the key binding.



useKey
boolean useKey(Object key, Object value, DatabaseEntry keyThang, KeyRange checkRange) throws DatabaseException(Code)
Populates the key entry and returns whether the key is within range.



useSubRange
KeyRange useSubRange() throws DatabaseException(Code)
Returns the range to use for sub-ranges. Returns range if this is not a dupsView, or the dupsRange if this is a dupsView, creating dupsRange if necessary.



useTransaction
Transaction useTransaction()(Code)
Returns the current transaction if the database is transaction, or null if the database is not transactional or there is no current transaction.



useValue
void useValue(Object value, DatabaseEntry valueThang, DatabaseEntry checkKeyThang) throws DatabaseException(Code)
Populates the value entry and throws an exception if the primary key would be changed via an entity binding.



valueSetView
DataView valueSetView()(Code)
Return a new value-set view derived from this view by setting the key binding to null. the derived view.



valueSetView
DataView valueSetView(Object singleKey) throws DatabaseException, KeyRangeException(Code)
Return a new value-set view for single key range.
Parameters:
  singleKey - the single key value. the derived view.
throws:
  DatabaseException - if a database problem occurs.
throws:
  KeyRangeException - if the specified range is not within thecurrent range.



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.