Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

java.gate.yam
Interface IOHandler

interface IOHandler

This interface is used by the YAM parser to initialise IO streams. It is provided in order to allow API users to supply IO management if needed.

author:
Hamish Cunningham

Method Summary
boolean exists(String path)

Check a path for existence.

boolean existsInContext(String path)

Check a path for existence relative to the context path.

String getBibAnchorPrefix()

Get the prefix added to citation keys, when forming a reference to a bibiography file entry

org.springframework.core.io.UrlResource getBibPageUrl()

Get the URL within which citation keys will be resolved.

String getContextPath()

Get the path in which to check for existence of relative links.

String getCreatePageUrl()

Get the URL which non-existent links will be pointed at (which presumably is the "create new page" URL for the parent wiki).

Reader getReader(String path)

Get a reader from a path.

Reader getReaderInContext(String path)

Get a reader from a path relative to the context path.

void setBibAnchorPrefix(String bibAnchorPrefix)

Set the prefix added to citation keys, when forming a reference to a bibiography file entry

void setBibPageUrl(org.springframework.core.io.UrlResource bibPageUrl)

Set the URL within which citation keys will be resolved.

void setContextPath(String contextPath)

Set the path in which to check for existence of relative links.

void setCreatePageUrl(String createPageUrl)

Set the URL which non-existent links will be pointed at (which presumably is the "create new page" URL for the parent wiki).

void setCreatePageUrl(org.springframework.core.io.UrlResource createPageUrl)

Set the URL which non-existent links will be pointed at (which presumably is the "create new page" URL for the parent wiki).

void setSourceDir(File sourceDir)

Set the source directory file.

 

Method Detail

exists

public boolean exists(String path)
Check a path for existence. Relative paths adjusted with sourceDir.

existsInContext

public boolean existsInContext(String path)
Check a path for existence relative to the context path.

getBibAnchorPrefix

public String getBibAnchorPrefix()
Get the prefix added to citation keys, when forming a reference to a bibiography file entry
see:
#setBibPageUrl(UrlResource)

getBibPageUrl

public org.springframework.core.io.UrlResource getBibPageUrl()
Get the URL within which citation keys will be resolved.
see:
#setBibPageUrl(UrlResource)

getContextPath

public String getContextPath()
Get the path in which to check for existence of relative links.

getCreatePageUrl

public String getCreatePageUrl()
Get the URL which non-existent links will be pointed at (which presumably is the "create new page" URL for the parent wiki).

getReader

public Reader getReader(String path)
Get a reader from a path.

getReaderInContext

public Reader getReaderInContext(String path)
Get a reader from a path relative to the context path.

setBibAnchorPrefix

public void setBibAnchorPrefix(String bibAnchorPrefix)
Set the prefix added to citation keys, when forming a reference to a bibiography file entry
see:
#setBibPageUrl(UrlResource)
param:
bibAnchorPrefix The prefix added to citation keys.

setBibPageUrl

public void setBibPageUrl(org.springframework.core.io.UrlResource bibPageUrl)
Set the URL within which citation keys will be resolved. The URL will be for a bibliography. Citation keys reference a part of this URL, an individual bibliographic entry. Citation keys will form the final fragment of this URL, and will be prefixed, as defined by the #setBibAnchorPrefix(String) setBibAnchorPrefix method
param:
bibPageUrl the URL of the bibliogrpahy.

setContextPath

public void setContextPath(String contextPath)
Set the path in which to check for existence of relative links.
param:
contextPath the path to search in.

setCreatePageUrl

public void setCreatePageUrl(String createPageUrl)
Set the URL which non-existent links will be pointed at (which presumably is the "create new page" URL for the parent wiki).
param:
createPageUrl the link to point to.

setCreatePageUrl

public void setCreatePageUrl(org.springframework.core.io.UrlResource createPageUrl)
Set the URL which non-existent links will be pointed at (which presumably is the "create new page" URL for the parent wiki).
param:
createPageUrl the link to point to.

setSourceDir

public void setSourceDir(File sourceDir)
Set the source directory file.

 

Groovy Documentation