Java Doc for ReferenceManager.java in  » Portal » Open-Portal » com » ecyrd » jspwiki » 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 » Portal » Open Portal » com.ecyrd.jspwiki 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.ecyrd.jspwiki.ReferenceManager

ReferenceManager
public class ReferenceManager extends BasicPageFilter (Code)
Keeps track of wikipage references:
  • What pages a given page refers to
  • What pages refer to a given page
This is a quick'n'dirty approach without any finesse in storage and searching algorithms; we trust java.util.*.

This class contains two HashMaps, m_refersTo and m_referredBy. The first is indexed by WikiPage names and contains a Collection of all WikiPages the page refers to. (Multiple references are not counted, naturally.) The second is indexed by WikiPage names and contains a Set of all pages that refer to the indexing page. (Notice - the keys of both Maps should be kept in sync.)

When a page is added or edited, its references are parsed, a Collection is received, and we crudely replace anything previous with this new Collection. We then check each referenced page name and make sure they know they are referred to by the new page.

Based on this information, we can perform non-optimal searches for e.g. unreferenced pages, top ten lists, etc.

The owning class must take responsibility of filling in any pre-existing information, probably by loading each and every WikiPage and calling this class to update the references when created.
author:
   ebu@memecry.net
since:
   1.6.1




Constructor Summary
public  ReferenceManager(WikiEngine engine)
     Builds a new ReferenceManager.

Method Summary
public synchronized  voidclearPageEntries(String pagename)
     Clears the references to a certain page so it's no longer in the map.
public synchronized  CollectionfindReferrers(String pagename)
     Find all pages that refer to this page.
public synchronized  CollectionfindUncreated(String wikiname)
     Finds all references to non-existant pages.
public synchronized  CollectionfindUncreated()
    
public synchronized  CollectionfindUnreferenced(String wikiname)
     Finds all unreferenced pages.
public synchronized  CollectionfindUnreferenced()
    
protected  MapgetReferredBy()
     Returns the referred-by list.
protected  MapgetRefersTo()
     Returns the refers-to list.
public  voidinitialize(Collection pages)
     Initializes the entire reference manager with the initial set of pages from the collection.
public synchronized  voidpageRemoved(WikiPage page)
    
public  voidpostSave(WikiContext context, String content)
     After the page has been saved, updates the reference lists.
public synchronized  voidupdateReferences(String page, Collection references)
     Updates the referred pages of a new or edited WikiPage.


Constructor Detail
ReferenceManager
public ReferenceManager(WikiEngine engine)(Code)
Builds a new ReferenceManager.
Parameters:
  engine - The WikiEngine to which this is meeting.




Method Detail
clearPageEntries
public synchronized void clearPageEntries(String pagename)(Code)
Clears the references to a certain page so it's no longer in the map.
Parameters:
  pagename - Name of the page to clear references for.



findReferrers
public synchronized Collection findReferrers(String pagename)(Code)
Find all pages that refer to this page. Returns null if the page does not exist or is not referenced at all, otherwise returns a collection containing page names (String) that refer to this one.



findUncreated
public synchronized Collection findUncreated(String wikiname)(Code)
Finds all references to non-existant pages. This requires a linear scan through m_refersTo values; each value must have a corresponding key entry in the reference Maps, otherwise such a page has never been created.

Returns a Collection containing Strings of unreferenced page names. Each non-existant page name is shown only once - we don't return information on who referred to it.




findUncreated
public synchronized Collection findUncreated()(Code)



findUnreferenced
public synchronized Collection findUnreferenced(String wikiname)(Code)
Finds all unreferenced pages. This requires a linear scan through m_referredBy to locate keys with null or empty values.



findUnreferenced
public synchronized Collection findUnreferenced()(Code)



getReferredBy
protected Map getReferredBy()(Code)
Returns the referred-by list. For debugging.



getRefersTo
protected Map getRefersTo()(Code)
Returns the refers-to list. For debugging.



initialize
public void initialize(Collection pages) throws ProviderException(Code)
Initializes the entire reference manager with the initial set of pages from the collection.
Parameters:
  pages - A collection of all pages you want to be included in the referencecount.
since:
   2.2



pageRemoved
public synchronized void pageRemoved(WikiPage page)(Code)



postSave
public void postSave(WikiContext context, String content)(Code)
After the page has been saved, updates the reference lists.



updateReferences
public synchronized void updateReferences(String page, Collection references)(Code)
Updates the referred pages of a new or edited WikiPage. If a refersTo entry for this page already exists, it is removed and a new one is built from scratch. Also calls updateReferredBy() for each referenced page.

This is the method to call when a new page has been created and we want to a) set up its references and b) notify the referred pages of the references. Use this method during run-time.
Parameters:
  page - Name of the page to update.
Parameters:
  references - A Collection of Strings, each one pointing to a page this page references.




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