Node Director
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
sfi.director.application.autodoc.DocExtDocu Class Reference

Handles external documents. More...

Public Member Functions

 DocExtDocu (DBObject docdef)
 DocExtDocu (String urn)
void store () throws DirectorException
 Store the current object meta information in the database.
DBObject toDBObject ()
boolean isInclude ()
boolean isInline ()
String categoryName ()
 Accessor for attribute categoryName.
String categoryName (String categoryName)
 Mutator for attribute categoryName.
String caption ()
 Accessor for attribute caption.
String caption (String caption)
 Mutator for attribute caption.
String file ()
 Accessor for attribute file.
String file (String file)
 Mutator for attribute file.
String urn ()
 Accessor for attribute urn.
String urn (String urn)
 Mutator for attribute urn.
String read () throws DirectorException
 returns the document text
void fetch () throws DirectorException

Static Public Member Functions

static DocExtDocu retrieve (String urn) throws DirectorException
static String mangledUrn (String urn)
static String unmangledUrn (String mangled)

Protected Attributes

String categoryName = null
 The document's category.
String caption = null
 The document title.
String file = null
 The document file.
String urn = null
 The URN associated with this document.

Detailed Description

Handles external documents.

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocExtDocu.DocExtDocu ( DBObject  docdef)

References sfi.director.application.autodoc.DocExtDocu.caption(), sfi.director.application.autodoc.DocExtDocu.categoryName(), sfi.director.application.autodoc.DocExtDocu.file(), sfi.director.repository.DBObject.getValue(), sfi.director.application.autodoc.DocExtDocu.unmangledUrn(), and sfi.director.application.autodoc.DocExtDocu.urn().

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

sfi.director.application.autodoc.DocExtDocu.DocExtDocu ( String  urn)

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

Member Function Documentation

String sfi.director.application.autodoc.DocExtDocu.caption ( )

Accessor for attribute caption.

The document title.

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

String sfi.director.application.autodoc.DocExtDocu.caption ( String  caption)

Mutator for attribute caption.

The document title.

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

String sfi.director.application.autodoc.DocExtDocu.categoryName ( )

Accessor for attribute categoryName.

The document's category.

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

String sfi.director.application.autodoc.DocExtDocu.categoryName ( String  categoryName)

Mutator for attribute categoryName.

The document's category.

References sfi.director.application.autodoc.DocExtDocu.categoryName().

void sfi.director.application.autodoc.DocExtDocu.fetch ( ) throws DirectorException

References sfi.director.application.autodoc.DocExtDocu.caption(), sfi.director.application.autodoc.DocURNHandler.caption, sfi.director.application.autodoc.DocURNHandler.category(), sfi.director.application.autodoc.DocExtDocu.categoryName(), sfi.director.application.autodoc.DocURNHandler.fetchInto(), sfi.director.application.autodoc.DocExtDocu.file(), sfi.director.application.autodoc.DocURNHandler.getHandler(), sfi.director.application.autodoc.DocBuilder.mediafile(), sfi.director.application.autodoc.DocURNHandler.type, sfi.director.util.Tools.uniqId(), and sfi.director.application.autodoc.DocExtDocu.urn().

Referenced by sfi.director.application.autodoc.DocExtDocu.retrieve(), and sfi.director.cli.docrefetch.run().

String sfi.director.application.autodoc.DocExtDocu.file ( )

Accessor for attribute file.

The document file.

Referenced by sfi.director.application.autodoc.DocExtDocu.DocExtDocu(), sfi.director.application.autodoc.DocExtDocu.fetch(), sfi.director.application.autodoc.DocExtDocu.file(), sfi.director.application.autodoc.DocExtDocu.isInclude(), sfi.director.application.autodoc.DocExtDocu.read(), and sfi.director.application.autodoc.DocExtDocu.toDBObject().

String sfi.director.application.autodoc.DocExtDocu.file ( String  file)

Mutator for attribute file.

The document file.

References sfi.director.application.autodoc.DocExtDocu.file().

boolean sfi.director.application.autodoc.DocExtDocu.isInclude ( )

References sfi.director.application.autodoc.DocExtDocu.file().

Referenced by sfi.director.application.autodoc.DocExtDocu.isInline(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

boolean sfi.director.application.autodoc.DocExtDocu.isInline ( )

References sfi.director.application.autodoc.DocExtDocu.isInclude(), and sfi.director.application.autodoc.DocExtDocu.urn().

Referenced by sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

static String sfi.director.application.autodoc.DocExtDocu.mangledUrn ( String  urn)
static

Referenced by sfi.director.application.autodoc.DocExtDocu.retrieve(), and sfi.director.application.autodoc.DocExtDocu.toDBObject().

String sfi.director.application.autodoc.DocExtDocu.read ( ) throws DirectorException

returns the document text

References sfi.director.application.autodoc.DocExtDocu.file(), and sfi.director.application.autodoc.DocBuilder.mediafile().

static DocExtDocu sfi.director.application.autodoc.DocExtDocu.retrieve ( String  urn) throws DirectorException
static

References sfi.director.application.autodoc.DocExtDocu.DocExtDocu(), sfi.director.application.autodoc.DocExtDocu.fetch(), sfi.director.application.autodoc.DocExtDocu.file, sfi.director.repository.config.DirectoryAccess.get(), sfi.director.repository.config.Directory.getDirectory(), sfi.director.util.Tools.log(), sfi.director.application.autodoc.DocExtDocu.mangledUrn(), sfi.director.application.autodoc.DocExtDocu.store(), sfi.director.application.autodoc.DocExtDocu.urn(), and sfi.director.util.Logger.WARNING.

Referenced by sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

void sfi.director.application.autodoc.DocExtDocu.store ( ) throws DirectorException

Store the current object meta information in the database.

References sfi.director.repository.DBObject.completeDN(), sfi.director.repository.config.DirectoryAccess.ensureOu(), sfi.director.repository.config.Directory.getDirectory(), sfi.director.repository.config.DirectoryAccess.replace(), and sfi.director.application.autodoc.DocExtDocu.toDBObject().

Referenced by sfi.director.application.autodoc.DocExtDocu.retrieve(), and sfi.director.cli.docrefetch.run().

DBObject sfi.director.application.autodoc.DocExtDocu.toDBObject ( )

References sfi.director.application.autodoc.DocExtDocu.caption(), sfi.director.application.autodoc.DocExtDocu.categoryName(), sfi.director.application.autodoc.DocExtDocu.file(), sfi.director.application.autodoc.DocExtDocu.mangledUrn(), sfi.director.repository.DBObject.setDN(), and sfi.director.application.autodoc.DocExtDocu.urn().

Referenced by sfi.director.application.autodoc.DocBuilder.slurpExternalDocs(), and sfi.director.application.autodoc.DocExtDocu.store().

static String sfi.director.application.autodoc.DocExtDocu.unmangledUrn ( String  mangled)
static

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

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

String sfi.director.application.autodoc.DocExtDocu.urn ( )

Accessor for attribute urn.

The URN associated with this document.

Referenced by sfi.director.application.autodoc.DocExtDocu.DocExtDocu(), sfi.director.application.autodoc.DocExtDocu.fetch(), sfi.director.application.autodoc.DocExtDocu.isInline(), sfi.director.application.autodoc.DocExtDocu.retrieve(), sfi.director.application.autodoc.DocExtDocu.toDBObject(), sfi.director.application.autodoc.DocExtDocu.unmangledUrn(), and sfi.director.application.autodoc.DocExtDocu.urn().

String sfi.director.application.autodoc.DocExtDocu.urn ( String  urn)

Mutator for attribute urn.

The URN associated with this document.

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

Member Data Documentation

String sfi.director.application.autodoc.DocExtDocu.caption = null
protected

The document title.

String sfi.director.application.autodoc.DocExtDocu.categoryName = null
protected

The document's category.

String sfi.director.application.autodoc.DocExtDocu.file = null
protected

The document file.

Referenced by sfi.director.application.autodoc.DocExtDocu.retrieve(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

String sfi.director.application.autodoc.DocExtDocu.urn = null
protected

The URN associated with this document.

Referenced by sfi.director.cli.docrefetch.run().

The documentation for this class was generated from the following file:
Generated on Sat Feb 4 2023 01:19:58 for Node Director by   doxygen 1.8.1.2