lucee.runtime

Interface PageSource

All Superinterfaces:

java.io.Serializable, SourceFile

public interface PageSource
extends SourceFile

extends the source file with class features

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists()
int	getAccessCount()
java.lang.String	getClazz()
java.lang.String	getComponentName()
java.lang.String	getFileName()
java.lang.String	getFullRealpath() Returns the full name (mapping/relpath).
java.lang.String	getJavaName()
long	getLastAccessTime()
Mapping	getMapping()
PageSource	getRealPage(java.lang.String relPath) get an new Pagesoure from ralpath
java.lang.String	getRealpath() returns the ralpath without the mapping
Resource	getResource() if the pageSource is based on a archive, Lucee returns the ra:// path
Resource	getResourceTranslated(PageContext pc) if the pageSource is based on a archive, translate the source to a zip:// Resource
java.lang.String[]	getSource()
Page	loadPage(ConfigWeb config) loads the Page from this PageSource
Page	loadPage(ConfigWeb config, Page defaultValue) loads the Page from this PageSource
Page	loadPage(PageContext pc)
Page	loadPage(PageContext pc, Page defaultValue)
boolean	physcalExists()
void	setLastAccessTime() set time last accessed (now)
void	setLastAccessTime(long lastAccess) sets time last accessed page

Methods inherited from interface lucee.runtime.SourceFile

getClassName, getDisplayPath, getFullClassName, getPackageName, getPhyscalFile, getRealPathAsVariableString

Method Detail

loadPage

Page loadPage(ConfigWeb config)
              throws PageException

loads the Page from this PageSource

Parameters:

config -

Returns:

page Loaded

Throws:

PageException

loadPage

Page loadPage(PageContext pc)
              throws PageException

Throws:

PageException

loadPage

Page loadPage(ConfigWeb config,
            Page defaultValue)
              throws PageException

loads the Page from this PageSource

Parameters:

config -

defaultValue -

Returns:

Page loaded

Throws:

PageException

loadPage

Page loadPage(PageContext pc,
            Page defaultValue)
              throws PageException

Throws:

PageException

getRealpath

java.lang.String getRealpath()

returns the ralpath without the mapping

Returns:

Returns the relpath.

getFullRealpath

java.lang.String getFullRealpath()

Returns the full name (mapping/relpath).

Returns:

mapping/relpath

getClazz

java.lang.String getClazz()

Returns:

returns the full class name (Example: lucee.web.test_cfm)

getFileName

java.lang.String getFileName()

Returns:

return the file name of the source file (test.cfm)

getResource

Resource getResource()

if the pageSource is based on a archive, Lucee returns the ra:// path

Specified by:

getResource in interface SourceFile

Returns:

return the Resource matching this PageSource

getResourceTranslated

Resource getResourceTranslated(PageContext pc)
                               throws PageException

if the pageSource is based on a archive, translate the source to a zip:// Resource

Parameters:

pc - the Page Context Object

Returns:

return the Resource matching this PageSource

Throws:

PageException

getJavaName

java.lang.String getJavaName()

Returns:

returns the a classname matching to filename (Example: /lucee/web/test_cfm)

getComponentName

java.lang.String getComponentName()

Returns:

returns the a package matching to file (Example: lucee.web)

getMapping

Mapping getMapping()

Returns:

returns mapping where PageSource based on

exists

boolean exists()

Returns:

returns if page source exists or not

physcalExists

boolean physcalExists()

Returns:

returns if the physical part of the source file exists

getSource

java.lang.String[] getSource()
                             throws java.io.IOException

Returns:

return the sozrce of the file as String array

Throws:

java.io.IOException

getRealPage

PageSource getRealPage(java.lang.String relPath)

get an new Pagesoure from ralpath

Parameters:

relPath -

Returns:

new Pagesource

setLastAccessTime

void setLastAccessTime(long lastAccess)

sets time last accessed page

Parameters:

lastAccess - time ast accessed

getLastAccessTime

long getLastAccessTime()

Returns:

returns time last accessed page

setLastAccessTime

void setLastAccessTime()

set time last accessed (now)

getAccessCount

int getAccessCount()

Returns:

returns how many this page is accessed since server is in use.