Java Doc for NameSpacedIndex.java in  » Search-Engine » Jofti » com » jofti » api » 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 » Search Engine » Jofti » com.jofti.api 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.jofti.api.NameSpacedIndex

NameSpacedIndex
public interface NameSpacedIndex extends CacheAccessor,Index(Code)
The main interface used by clients of caches that are Name Spaced indexes.

The interface uses similar methods to the Map interface as most cache implementations can be easily adapted to these methods.

As with the Map classes the metaphors are to add an object use the put method, to retrieve an object use get(nameSpace,key) and to remove use remove(nameSpace,key).

The additional parameter on all these methods is a nameSpace object. The format of this object will depend on the cache implementation used. For JBossCache, for instance, the name Space is of type org.jboss.cache.Fqn.

The additional query method is for clients to query the cache by values other than the key. Please refer to the docs on IndexQuery.

It is important to realise that although the interface takes an Object as both key and value, some caches will only allow certain types of Objects to be inserted. Check with the actual cache provider used to determine these limitations.

The usage to obtain an indexed cache is to create a com.jofti.manager.IndexManager then use the getNameSpacedIndex method to obtain a reference to the indexed cache. You cannot retrieve a nameSpaced indexed cache using the getIndex method.


author:
   Steve Woodcock

version:
   1.4





Method Summary
public  Objectget(Object nameSpace, Object key)
     Retrieves an object from the underlying cache instance.
public  voidput(Object nameSpace, Object key, Object value)
     Puts an object into the underlying cache instance and indexes the object according to the class definitions in the index config file.
public  voidremove(Object nameSpace, Object key)
     Deletes an object from the underlying cache.
public  voidremoveAll()
    
public  voidremoveNameSpace(Object nameSpace)
     Deletes all objects from the underlying cache within the namespace.



Method Detail
get
public Object get(Object nameSpace, Object key)(Code)
Retrieves an object from the underlying cache instance. The behaviour of the caches have been normalised so that a not found object will always return null - rather than throw an exception (as some caches do) any cache error tranformed into a log message only. This method only provides this normalised behaviour as it the caches are usually read-mostly in operation and most caches already do this.


Parameters:
  nameSpace - value to use for nameSpace


Parameters:
  key - the key for the object in the name sapce cache
the object mapped in the cache - or null if no object found.




put
public void put(Object nameSpace, Object key, Object value) throws JoftiException(Code)
Puts an object into the underlying cache instance and indexes the object according to the class definitions in the index config file. Some caches may only accept certain types of objects.


Parameters:
  nameSpace - value to use for nameSpace

Parameters:
  key - value to use as key in cache


Parameters:
  value - value to put into cache and to be indexed


throws:
  JoftiException - thrown as a wrapper exception that contains any cache specific exceptions.




remove
public void remove(Object nameSpace, Object key) throws JoftiException(Code)
Deletes an object from the underlying cache. Attempting to remove a non-existant object will not generate an exception. This will also remove the key/object from the index.


Parameters:
  nameSpace - value to use for nameSpace

Parameters:
  key - the key to remove from the cache

throws:
  JoftiException - - A wrapper for any cache specific exceptions or exceptions generated by the index.




removeAll
public void removeAll() throws JoftiException(Code)
This will remove all the values in the cache and dump the current index.


throws:
  JoftiException - A wrapper for any cache specific exceptions or exceptions generated by the index.




removeNameSpace
public void removeNameSpace(Object nameSpace) throws JoftiException(Code)
Deletes all objects from the underlying cache within the namespace. Attempting to remove a non-existant object will not generate an exception. This will also remove the key/object entries for the namespace from the index.


Parameters:
  nameSpace - value to use for nameSpace

throws:
  JoftiException - - A wrapper for any cache specific exceptions or exceptions generated by the index.




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