com.pepper.platform.page
Class PageInfo

java.lang.Object
  extended by com.pepper.platform.page.PageInfo

public class PageInfo
extends Object

Encapsulates info about a Page, including it's Section, it's index in the list of pages, and it's SectionPageMgr


Constructor Summary
PageInfo(com.pepper.platform.program.SectionPageMgr sectionPageMgr, Page page, int index)
          Creates a new PageInfo instance.
 
Method Summary
 com.pepper.platform.xml.GeneratedPage getGeneratedPage()
          Get the input stream that represents the page output after it is run through it's correct transformer
 int getIndex()
          Describe getIndex method here.
 int getLoadFlags()
          Get the load flags to use when loading this page.
 Page getPage()
          Describe getPage method here.
 String getProperty(String propName)
          Get a particular value of a query string attribute
 HashMap getQueryMap()
          Get a HashMap containing name/value pairs representing values in the query string of the url
 Section getSection()
          Describe getSection method here.
 com.pepper.platform.program.SectionPageMgr getSectionPageMgr()
          Describe getSectionPageMgr method here.
 InputStream getTransformedPageInputStream()
          Get the input stream that represents the page output after it is run through it's correct transformer
 URL getURL()
          get the url that this pageInfo represents
 void setGeneratedPage(com.pepper.platform.xml.GeneratedPage thePage)
          Set the page output after it is run through it's correct transform
 void setIndex(int index)
          Describe setIndex method here.
 void setLoadFlags(int loadFlags)
          Set teh load flags to use when loading this page
 void setQueryMap(HashMap queryMap)
          Set the queryMap that contains name/value pairs representing values in the query string of the url
 void setTransformedPageInputStream(InputStream stream)
          Set the input stream that represents the page output after it is run through it's correct transform
 void setURL(URL url)
          set the url that this pageInfo represents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageInfo

public PageInfo(com.pepper.platform.program.SectionPageMgr sectionPageMgr,
                Page page,
                int index)
Creates a new PageInfo instance.

Parameters:
sectionPageMgr - a SectionPageMgr value
page - a Page value
index - an int value
Method Detail

setURL

public void setURL(URL url)
set the url that this pageInfo represents

Parameters:
url - an URL value

getURL

public URL getURL()
get the url that this pageInfo represents

Returns:
an URL value

setQueryMap

public void setQueryMap(HashMap queryMap)
Set the queryMap that contains name/value pairs representing values in the query string of the url

Parameters:
queryMap - a HashMap value

getQueryMap

public HashMap getQueryMap()
Get a HashMap containing name/value pairs representing values in the query string of the url

Returns:
a HashMap value

getProperty

public String getProperty(String propName)
Get a particular value of a query string attribute

Parameters:
propName - query string attribute
Returns:
a String value

getIndex

public int getIndex()
Describe getIndex method here.

Returns:
an int value

setIndex

public void setIndex(int index)
Describe setIndex method here.

Parameters:
index - an int value

getPage

public Page getPage()
Describe getPage method here.

Returns:
a Page value

getSection

public Section getSection()
Describe getSection method here.

Returns:
a Section value

getSectionPageMgr

public com.pepper.platform.program.SectionPageMgr getSectionPageMgr()
Describe getSectionPageMgr method here.

Returns:
a SectionPageMgr value

setTransformedPageInputStream

public void setTransformedPageInputStream(InputStream stream)
Set the input stream that represents the page output after it is run through it's correct transform

Parameters:
stream - an InputStream value

getTransformedPageInputStream

public InputStream getTransformedPageInputStream()
Get the input stream that represents the page output after it is run through it's correct transformer

Returns:
an InputStream value

setGeneratedPage

public void setGeneratedPage(com.pepper.platform.xml.GeneratedPage thePage)
Set the page output after it is run through it's correct transform

Parameters:
thePage - a GeneratedPage value

getGeneratedPage

public com.pepper.platform.xml.GeneratedPage getGeneratedPage()
Get the input stream that represents the page output after it is run through it's correct transformer

Returns:
a GeneratedPage value

getLoadFlags

public int getLoadFlags()
Get the load flags to use when loading this page. The value will be cleared after the page is loaded

Returns:
an int value
See Also:
WebNavigationConstants

setLoadFlags

public void setLoadFlags(int loadFlags)
Set teh load flags to use when loading this page

Parameters:
loadFlags - an int value
See Also:
WebNavigationConstants


Copyright © 2006-2007 Pepper Computer, Inc. All Rights Reserved.