Java Doc for XMLPageManager.java in  » Web-Framework » jpublish » org » jpublish » page » xml » 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 » Web Framework » jpublish » org.jpublish.page.xml 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jpublish.page.AbstractPageManager
      org.jpublish.page.xml.XMLPageManager

XMLPageManager
public class XMLPageManager extends AbstractPageManager implements ResourceRecipient(Code)
Implementation of the PageManager interface which pulls all page definitions from a single XML file. A default page can be specified as a failover in case a page is not defined.

Note: The XMLPageManager does not support writing. Any method which would modify pages in the page manager will throw an UnsupportedOperationException.


author:
   Anthony Eden


Field Summary
final public static  StringDEFAULT_FILE_NAME
     The default file name for the configuration file (pages.xml).
protected  PageDefinitiondefaultPageDefinition
    
protected  Filefile
    
protected  MappageDefinitions
    
protected  Listpaths
    

Constructor Summary
public  XMLPageManager()
     Construct a new XMLPageManager.

Method Summary
public  FilegetFile()
     Get the configuration File object.
public synchronized  PageInstancegetPage(String path)
     Get a PageInstance from the given path.
public  IteratorgetPages()
     Get an iterator which can be used to iterate through all pages known to the PageManager.
public  IteratorgetPages(String path)
     Get an iterator which can be used to iterate through all the pages at or below the specified path.
public synchronized  VFSFilegetVFSRoot()
     Get the Virtual File System root file.
public  voidload(InputStream in)
     Load all page definitions from the given configuration InputStream.
public  voidloadConfiguration(Configuration configuration)
     Load the XMLPageManager configuration.
protected  voidloadPageDefinitions()
     Load the Page definitions from an XML configuration file.
public  voidmakeDirectory(String path)
     Make the directory for the specified path.
public  voidputPage(String path, PageInstance page)
     Put the page instance into the location specified by the given path.
public  voidremoveDirectory(String path)
     Remove the directory for the specified path.
public  voidremovePage(String path)
     Remove the page at the specified path.
public  voidsetFile(File file)
     Set the configuration File object.
public  voidsetFile(String file)
     Set the configuration File object using the given File path String.

Field Detail
DEFAULT_FILE_NAME
final public static String DEFAULT_FILE_NAME(Code)
The default file name for the configuration file (pages.xml).



defaultPageDefinition
protected PageDefinition defaultPageDefinition(Code)



file
protected File file(Code)



pageDefinitions
protected Map pageDefinitions(Code)



paths
protected List paths(Code)




Constructor Detail
XMLPageManager
public XMLPageManager()(Code)
Construct a new XMLPageManager.




Method Detail
getFile
public File getFile()(Code)
Get the configuration File object. The configuration file



getPage
public synchronized PageInstance getPage(String path) throws Exception(Code)
Get a PageInstance from the given path. If no page can be found then this method will throw a FileNotFoundException.
Parameters:
  path - The page path The Page
throws:
  Exception - Any Exception



getPages
public Iterator getPages() throws Exception(Code)
Get an iterator which can be used to iterate through all pages known to the PageManager. An Iterator of Pages
throws:
  Exception - Any Exception



getPages
public Iterator getPages(String path) throws Exception(Code)
Get an iterator which can be used to iterate through all the pages at or below the specified path. If the path refers to a file, then the file's parent directory is used.
Parameters:
  path - The base path An Iterator of Pages
throws:
  Exception - Any Exception



getVFSRoot
public synchronized VFSFile getVFSRoot() throws Exception(Code)
Get the Virtual File System root file. The Virtual File System provides a datasource-independent way of navigating through all items known to the PageManager. The root VFSFile
throws:
  Exception -



load
public void load(InputStream in) throws Exception(Code)
Load all page definitions from the given configuration InputStream.
Parameters:
  in - The InputStream
throws:
  Exception - Any Exception



loadConfiguration
public void loadConfiguration(Configuration configuration) throws ConfigurationException(Code)
Load the XMLPageManager configuration.
Parameters:
  configuration - The Configuration object
throws:
  ConfigurationException -



loadPageDefinitions
protected void loadPageDefinitions() throws Exception(Code)
Load the Page definitions from an XML configuration file.
throws:
  Exception - Any Exception



makeDirectory
public void makeDirectory(String path)(Code)
Make the directory for the specified path. Parent directories will also be created if they do not exist. The XMLPageManager does not currently support writing, so this method will throw an UnsupportedOperationException.
Parameters:
  path - The directory path



putPage
public void putPage(String path, PageInstance page) throws Exception(Code)
Put the page instance into the location specified by the given path. The XMLPageManager does not currently support writing, so this method will throw an UnsupportedOperationException.
Parameters:
  path - The page path
Parameters:
  page - The Page object
throws:
  Exception -



removeDirectory
public void removeDirectory(String path) throws Exception(Code)
Remove the directory for the specified path. The directory must be empty. The XMLPageManager does not currently support writing, so this method will throw an UnsupportedOperationException.
Parameters:
  path - The path
throws:
  Exception -



removePage
public void removePage(String path) throws Exception(Code)
Remove the page at the specified path. The XMLPageManager does not currently support writing, so this method will throw an UnsupportedOperationException.
Parameters:
  path - The page path
throws:
  Exception -



setFile
public void setFile(File file)(Code)
Set the configuration File object.
Parameters:
  file - The configuration file



setFile
public void setFile(String file)(Code)
Set the configuration File object using the given File path String.
Parameters:
  file - The configuration file path



Fields inherited from org.jpublish.page.AbstractPageManager
protected SiteContext siteContext(Code)(Java Doc)

Methods inherited from org.jpublish.page.AbstractPageManager
public Reader getPageConfigurationReader(String path) throws Exception(Code)(Java Doc)
public Writer getPageConfigurationWriter(String path) throws Exception(Code)(Java Doc)
public SiteContext getSiteContext()(Code)(Java Doc)
public void loadConfiguration(Configuration configuration) throws ConfigurationException(Code)(Java Doc)
public void makeDirectory(String path)(Code)(Java Doc)
public void putPage(String path, PageInstance page) throws Exception(Code)(Java Doc)
public void removeDirectory(String path) throws Exception(Code)(Java Doc)
public void removePage(String path) throws Exception(Code)(Java Doc)
public void setSiteContext(SiteContext siteContext)(Code)(Java Doc)

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.