sfi.director.application.autodoc.DocURNHandler Class Reference

Handles retrieval of external documents identified by URNs. More...

Public Member Functions
	DocURNHandler (DBObject dbo)
DocURNHandler	instantiate (String urn)
int	matches (String urn)
DBObject	handlerDef ()
String	urn ()
String	localURN ()
String	fetch () throws DirectorException
void	fetchInto (java.io.File file) throws DirectorException
void	fetchInto (java.io.OutputStream out) throws DirectorException
String	category ()
	Accessor for attribute category.
String	caption ()
	Accessor for attribute caption.
String	caption (String caption)
	Mutator for attribute caption.
String	type ()
	Accessor for attribute type.
String	type (String type)
	Mutator for attribute type.

Static Public Member Functions
static DocURNHandler	getHandler (String urn)

Protected Member Functions
Object	_setupIO (String kind) throws DirectorException

Static Protected Member Functions
static Vector	getHandlers ()

Protected Attributes
String	caption = null
String	type = null

Detailed Description

Handles retrieval of external documents identified by URNs.

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocURNHandler.DocURNHandler

(

DBObject

dbo

)

References sfi.director.application.autodoc.DocURNHandler.handlerDef().

Referenced by sfi.director.application.autodoc.DocURNHandler.getHandler(), sfi.director.application.autodoc.DocURNHandler.getHandlers(), and sfi.director.application.autodoc.DocURNHandler.instantiate().

Member Function Documentation

Object sfi.director.application.autodoc.DocURNHandler._setupIO ( String  kind ) throws DirectorException

protected

References sfi.director.repository.DBObject.getValue(), and sfi.director.application.autodoc.DocURNHandler.handlerDef().

Referenced by sfi.director.application.autodoc.DocURNHandler.fetchInto().

String sfi.director.application.autodoc.DocURNHandler.caption

(

)

Accessor for attribute caption.

Referenced by sfi.director.application.autodoc.DocURNHandler.caption(), and sfi.director.application.autodoc.DocURNHandler.fetchInto().

String sfi.director.application.autodoc.DocURNHandler.caption

(

String

caption

)

Mutator for attribute caption.

References sfi.director.application.autodoc.DocURNHandler.caption().

String sfi.director.application.autodoc.DocURNHandler.category

(

)

Accessor for attribute category.

Accessor for attribute category.

References sfi.director.repository.DBObject.getValue(), and sfi.director.application.autodoc.DocURNHandler.handlerDef().

Referenced by sfi.director.application.autodoc.DocExtDocu.fetch().

String sfi.director.application.autodoc.DocURNHandler.fetch

(

)

throws DirectorException

References sfi.director.application.autodoc.DocURNHandler.fetchInto().

void sfi.director.application.autodoc.DocURNHandler.fetchInto

(

java.io.File

file

)

throws DirectorException

References sfi.director.application.autodoc.DocURNHandler.urn().

Referenced by sfi.director.application.autodoc.DocURNHandler.fetch(), and sfi.director.application.autodoc.DocExtDocu.fetch().

void sfi.director.application.autodoc.DocURNHandler.fetchInto

(

java.io.OutputStream

out

)

throws DirectorException

References sfi.director.application.autodoc.DocURNHandler._setupIO(), sfi.director.application.autodoc.urn.Fetcher.caption(), sfi.director.application.autodoc.DocURNHandler.caption(), sfi.director.util.Tools.copy(), sfi.director.util.Tools.debug(), sfi.director.application.autodoc.urn.Fetcher.inputStream(), sfi.director.application.autodoc.urn.Fetcher.type(), sfi.director.application.autodoc.DocURNHandler.type(), sfi.director.application.autodoc.DocURNHandler.urn(), and sfi.director.application.autodoc.urn.Fetcher.URNHandler().

static DocURNHandler sfi.director.application.autodoc.DocURNHandler.getHandler ( String  urn )

static

References sfi.director.application.autodoc.DocURNHandler.DocURNHandler(), sfi.director.application.autodoc.DocURNHandler.getHandlers(), sfi.director.application.autodoc.DocURNHandler.instantiate(), and sfi.director.application.autodoc.DocURNHandler.matches().

Referenced by sfi.director.application.autodoc.DocExtDocu.fetch().

static Vector sfi.director.application.autodoc.DocURNHandler.getHandlers ( )

staticprotected

References sfi.director.util.Cache.add(), sfi.director.application.autodoc.DocURNHandler.DocURNHandler(), sfi.director.util.Cache.get(), sfi.director.repository.config.Directory.getDirectory(), sfi.director.repository.DBObject.isMember(), and sfi.director.repository.config.DirectoryAccess.search().

Referenced by sfi.director.application.autodoc.DocURNHandler.getHandler().

DBObject sfi.director.application.autodoc.DocURNHandler.handlerDef

(

)

Referenced by sfi.director.application.autodoc.DocURNHandler._setupIO(), sfi.director.application.autodoc.DocURNHandler.category(), sfi.director.application.autodoc.DocURNHandler.DocURNHandler(), and sfi.director.application.autodoc.DocURNHandler.matches().

DocURNHandler sfi.director.application.autodoc.DocURNHandler.instantiate

(

String

urn

)

References sfi.director.application.autodoc.DocURNHandler.DocURNHandler().

Referenced by sfi.director.application.autodoc.DocURNHandler.getHandler().

String sfi.director.application.autodoc.DocURNHandler.localURN

(

)

References sfi.director.application.autodoc.DocURNHandler.matches(), and sfi.director.application.autodoc.DocURNHandler.urn().

int sfi.director.application.autodoc.DocURNHandler.matches

(

String

urn

)

References sfi.director.repository.DBObject.getAttribute(), and sfi.director.application.autodoc.DocURNHandler.handlerDef().

Referenced by sfi.director.application.autodoc.DocURNHandler.getHandler(), and sfi.director.application.autodoc.DocURNHandler.localURN().

String sfi.director.application.autodoc.DocURNHandler.type

(

)

Accessor for attribute type.

Referenced by sfi.director.application.autodoc.DocURNHandler.fetchInto(), and sfi.director.application.autodoc.DocURNHandler.type().

String sfi.director.application.autodoc.DocURNHandler.type

(

String

type

)

Mutator for attribute type.

References sfi.director.application.autodoc.DocURNHandler.type().

String sfi.director.application.autodoc.DocURNHandler.urn

(

)

Referenced by sfi.director.application.autodoc.DocURNHandler.fetchInto(), and sfi.director.application.autodoc.DocURNHandler.localURN().

Member Data Documentation

String sfi.director.application.autodoc.DocURNHandler.caption = null

protected

Referenced by sfi.director.application.autodoc.DocExtDocu.fetch().

String sfi.director.application.autodoc.DocURNHandler.type = null

protected

Referenced by sfi.director.application.autodoc.DocExtDocu.fetch().

---

The documentation for this class was generated from the following file:

• director/src/sfi/director/application/autodoc/DocURNHandler.java