Java Doc for BlogNavigator.java in  » J2EE » OpenCore » org » opensubsystems » blog » www » 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 » J2EE » OpenCore » org.opensubsystems.blog.www 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.opensubsystems.blog.www.BlogNavigator

All known Subclasses:   org.opensubsystems.blog.www.DynamicBlogNavigator,
BlogNavigator
public class BlogNavigator (Code)
Class responsible for parsing and creating URLs for blogs and their entries. If root URL is http://www.opensubsystems.org then the structure of URLs is - Bog with folder "firstblog" root URL = http://www.opensubsystems.org/firstblog/ page URL = http://www.opensubsystems.org/firstblog/index.html - Entry belonging to "firstblog" with ID 123456789 page URL = http://www.opensubsystems.org/firstblog/123456789.html
version:
   $Id: BlogNavigator.java,v 1.4 2007/02/20 03:54:31 bastafidli Exp $
author:
   Miro Halas


Field Summary
final public static  StringLOGIN_WEB_PAGE
     Page where user can login to the system.
final public static  StringLOGOUT_WEB_PAGE
     Page where user can logout to the system.
final public static  StringPAGED_ACCESS_WEB_PAGE
    
protected  HttpServletRequestm_hsrqRequest
    
protected  Stringm_strBlogDirectoryURL
     URL to the directory containing all blogs.

Constructor Summary
public  BlogNavigator(HttpServletRequest hsrqRequest)
    

Method Summary
public  BlogEntryIdentificationgetBlogEntryIdentification(HttpServletRequest hsrqRequest)
     Get blog and entries which coresponds to given request.
Parameters:
  hsrqRequest - - the servlet request.
protected  StringgetBlogEntryURL(String strFolder, int iEntryId)
     Get URL to the page which displays specified blog entry.
public  ObjectgetBlogIdentification(HttpServletRequest hsrqRequest)
     Get blog which coresponds to given request.
Parameters:
  hsrqRequest - - the servlet request.
protected  StringBuffergetBlogRootURL(String strId)
     Get URL to the root directory where all entries for given blog exist.
public  StringgetBlogURL(Object objBlogIdentification)
     Get URL to the page that displays specified blog.
public  StringgetFirstPageURL()
     Get URL that allows user to display the first page of the list with the data.
public  booleangetIsDynamic()
     Flag signaling if the navigator creates dynamic URLS (e.g.
public  StringgetLastPageURL()
     Get URL that allows user to display the last page of the list with the data.
public  StringgetNextPageURL()
     Get URL that allows user to display the next page of the list with the data.
protected  StringgetPageOffsetURL(int iOffset, boolean bAbsolute)
     Get URL that allows user to display same page of the list with the data.
public  StringgetPostURL()
    
public  StringgetPreviousPageURL()
     Get URL that allows user to display the previous page of the list with the data.
public  StringgetRootURL()
     Get URL to the root directory where all blogs exist.
public  StringgetURL(Blog blog)
     Get URL to the page which displays this blog.
public  StringgetURL(Blog blog, Entry entry)
     Get URL to the page which displays specified entry.
public  StringgetURL(Entry entry)
    
public  StringgetURL(BlogEntryIdentification entryIdentification)
     Get URL to the page which displays specified blog entry.
public  booleanisBlogIndexPage()
     Test if specified request identifies path to a blog index page.
public  intisIndexPage()
    
public  booleanisLoginPage()
     Test if the requested path is path to the page where user can login to the system.
public  booleanisLogoutPage()
     Test if the requested path is path to the page where user can login to the system.

Field Detail
LOGIN_WEB_PAGE
final public static String LOGIN_WEB_PAGE(Code)
Page where user can login to the system.



LOGOUT_WEB_PAGE
final public static String LOGOUT_WEB_PAGE(Code)
Page where user can logout to the system.



PAGED_ACCESS_WEB_PAGE
final public static String PAGED_ACCESS_WEB_PAGE(Code)
Default name stem to use when constructing



m_hsrqRequest
protected HttpServletRequest m_hsrqRequest(Code)
Request that will be used by this navigator



m_strBlogDirectoryURL
protected String m_strBlogDirectoryURL(Code)
URL to the directory containing all blogs.




Constructor Detail
BlogNavigator
public BlogNavigator(HttpServletRequest hsrqRequest)(Code)
Creates a new instance of BlogNavigator
Parameters:
  hsrqRequest - - request that will be used by this navigator




Method Detail
getBlogEntryIdentification
public BlogEntryIdentification getBlogEntryIdentification(HttpServletRequest hsrqRequest)(Code)
Get blog and entries which coresponds to given request.
Parameters:
  hsrqRequest - - the servlet request. BlogEntryIdentification



getBlogEntryURL
protected String getBlogEntryURL(String strFolder, int iEntryId)(Code)
Get URL to the page which displays specified blog entry.
Parameters:
  strFolder - - folder where this entry belongs to
Parameters:
  iEntryId - - id of entry to get page URL for String - URL to the page displaying specified entry



getBlogIdentification
public Object getBlogIdentification(HttpServletRequest hsrqRequest)(Code)
Get blog which coresponds to given request.
Parameters:
  hsrqRequest - - the servlet request. Object - Identification of Blog coresponding to given request. This can be either String value identifying the Blog folder or Integer value identifying the Blog URL.Ff no such Blog exists, an exception will be thrown



getBlogRootURL
protected StringBuffer getBlogRootURL(String strId)(Code)
Get URL to the root directory where all entries for given blog exist.
Parameters:
  strId - - ID of the blog to get root URL for String - URL ends with WebCommonConstants.URL_SEPARATOR_CHAR



getBlogURL
public String getBlogURL(Object objBlogIdentification)(Code)
Get URL to the page that displays specified blog.
Parameters:
  objBlogIdentification - - identification of the blog to get page URL for, which should be the folder String



getFirstPageURL
public String getFirstPageURL()(Code)
Get URL that allows user to display the first page of the list with the data. The navigator will correctly identify if it is list of blogs or blog entries and create the proper page URL. String - url to display the first page of list of data



getIsDynamic
public boolean getIsDynamic()(Code)
Flag signaling if the navigator creates dynamic URLS (e.g. URLS with ? and &) or it creates URLs that ressemble static pages (e.g. http://www.bastafidli.com/myblog/page7.html) boolean



getLastPageURL
public String getLastPageURL()(Code)
Get URL that allows user to display the last page of the list with the data. The navigator will correctly identify if it is list of blogs or blog entries and create the proper page URL. String - url to display the last page of list of data



getNextPageURL
public String getNextPageURL()(Code)
Get URL that allows user to display the next page of the list with the data. The navigator will correctly identify if it is list of blogs or blog entries and create the proper page URL. String - url to display next page of list of data



getPageOffsetURL
protected String getPageOffsetURL(int iOffset, boolean bAbsolute)(Code)
Get URL that allows user to display same page of the list with the data. The navigator will correctly identify if it is list of blogs or blog entries and create the proper page URL.
Parameters:
  iOffset - - offset of the page to display
Parameters:
  bAbsolute - - if true then the offset is taken as an absolute otherwise it is relative to current page, +1 will be the next page, -1 will be the first page String - url to display specified page of list of data



getPostURL
public String getPostURL()(Code)
Get URL to where a form can be posted to be processed String - URL to posts the forms to



getPreviousPageURL
public String getPreviousPageURL()(Code)
Get URL that allows user to display the previous page of the list with the data. The navigator will correctly identify if it is list of blogs or blog entries and create the proper page URL. String - url to display previous page of list of data



getRootURL
public String getRootURL()(Code)
Get URL to the root directory where all blogs exist. String - URL ends with WebCommonConstants.URL_SEPARATOR_CHAR



getURL
public String getURL(Blog blog)(Code)
Get URL to the page which displays this blog.
Parameters:
  blog - - blog to get page URL for String



getURL
public String getURL(Blog blog, Entry entry)(Code)
Get URL to the page which displays specified entry.
Parameters:
  blog - - blog to which this entry belongs to
Parameters:
  entry - - entry to get page URL for String - URL to the page displaying specified entry



getURL
public String getURL(Entry entry)(Code)
Get URL to the page which displays specified entry without knowing details of the blog the entry belongs to
Parameters:
  entry - - entry to get page URL for String - URL to the page displaying specified entry



getURL
public String getURL(BlogEntryIdentification entryIdentification)(Code)
Get URL to the page which displays specified blog entry.
Parameters:
  entryIdentification - - identification of entry String - URL to the page displaying specified entry



isBlogIndexPage
public boolean isBlogIndexPage()(Code)
Test if specified request identifies path to a blog index page. It either doesn't contain any path e.g. http://www.bastafidli.com or just a root directory http://www.bastafidli.com/ with some index page already tested by isIndexPage. boolean - true if the page is index page for blogs



isIndexPage
public int isIndexPage()(Code)
Test if the given request is a request for data displayed on an index page which is page identified either as index.html or as pageXYZ.html where XYZ is a number int - if the request identifies a valid index page then the pagenumber (a positive value) is returned otherwise a negative value is returned.



isLoginPage
public boolean isLoginPage()(Code)
Test if the requested path is path to the page where user can login to the system. boolean - true if the page is login page



isLogoutPage
public boolean isLogoutPage()(Code)
Test if the requested path is path to the page where user can login to the system. boolean - true if the page is login page



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.