sfi.director.application.autodoc.DocInfo Class Reference

Access to documentation records. More...

Public Member Functions
	DocInfo (DBObject record) throws DirectorException
	DocInfo (DBObject record, DirectoryAccess dir) throws DirectorException
	DocInfo (DBObject record, DirectoryAccess dir, String nameAttr) throws DirectorException
DocChapter	addIntroChapter (DocBuilder builder, String title[], DocCategory category) throws DirectorException
DocChapter	addIntroChapter (DocBuilder builder, String title[], DocCategory category, boolean onlyIfNotEmpty) throws DirectorException
String	templateText ()
void	locationDocu (DocBuilder builder, DocChapter parent, DocCategory category) throws DirectorException
int	detaillevel (DBObject adjObject, int defaultLevel)
Vector	getImages ()
	get a Vector of image URLs.
Vector	getImages (DBObject obj)
Vector	getImageOpts ()
	get a Vector of image Options, each option object is a pendant to the respective entry in getImages().
Vector	getImageOpts (DBObject obj)
Vector	getDocs ()
	get a Vector of doc URLs.
Vector	getDocs (DBObject doc)
Vector	getDocOpts ()
	get a Vector of doc Options, each option object is a pendant to the respective entry in getDocs().
Vector	getDocOpts (DBObject doc)
Vector	getDocOpts (String attribute)
	get a Vector of Options out of the named attribute
Vector	getDocOpts (DBObject doc, String attribute)
DBObject	docObject ()
	Accessor for attribute docObject.
DBObject	docObject (DBObject docObject)
	Mutator for attribute docObject.
DBObject	docObject (DBObject docObject, String nameAttr)
	Set docObject and compute the name from the attribute with the given name.
Vector	adjDocObjs ()
	Accessor for attribute adjDocObjs.
Vector	adjDocObjs (Vector adjDocObjs)
	Mutator for attribute adjDocObjs.
void	addAdjuncts (DirectoryAccess directory, DBObject dbo) throws DirectorException
	add adjunct document objs for the given object
String	name ()
	Accessor for attribute name.
String	name (String name)
	Mutator for attribute name.
String	title ()
	Accessor for attribute title.
String	title (String title)
	Mutator for attribute title.
DirectoryAccess	directory ()
	Accessor for attribute directory.
DirectoryAccess	directory (DirectoryAccess directory)
	Mutator for attribute directory.
String	label ()
	Accessor for attribute label.
String	label (String label)
	Mutator for attribute label.
void	genLabel ()
	Generate a label for this object that can later be used to create references to it.
Vector	aliases ()
	Accessor for attribute aliases.
Vector	aliases (Vector aliases)
	Mutator for attribute aliases.
Vector	aliasLabels ()
	Accessor for attribute aliasLabels.
Vector	aliasLabels (Vector aliasLabels)
	Mutator for attribute aliasLabels.
void	addAliasLabel (String label)
	adds a label.
DBObject	templateParams ()
	Accessor for attribute templateParams.
DBObject	templateParams (DBObject templateParams)
	Mutator for attribute templateParams.
void	addClassInfo () throws DirectorException
	Slurp in documentation records from super classes.
DBObject	searchFirst (String objectclass)
DBObject	location ()
Vector	searchAndRevise (String objectclass)
	Searches for information of the given type and applies rules for auto-scan objects.
Vector	configFileSpecs () throws DirectorException
	Looking at the documentation objects build a list of config file specs found in the various objects.

Protected Attributes
DBObject	docObject = null
	The (raw) DBObject we base our info on.
Vector	adjDocObjs = new Vector()
String	name = null
	The name/ID of the object. Initially set to reflect the appropriate docObject attr.
String	title = null
	The title of the object. This is often the same as the name(), but not always.
DirectoryAccess	directory = null
	The DirectoryAccess where the docObject is stored.
String	label = null
Vector	aliases = new Vector()
	aliases for this object. Alternative name().
Vector	aliasLabels = new Vector()
	additional labels
DBObject	templateParams = null
	the parameter/values to be filled in templates
Cache	infoCache = new Cache( 120, 120 )

Detailed Description

Access to documentation records.

Allows retrieval of the various documentation information stored either within a given DBObject, in its documentation sub-objects, or even in the respective Host/PeopleClass.

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocInfo.DocInfo

(

DBObject

record

)

throws DirectorException

Referenced by sfi.director.application.autodoc.DocInfo.locationDocu().

sfi.director.application.autodoc.DocInfo.DocInfo	(	DBObject	record,
		DirectoryAccess	dir
	)		throws DirectorException

sfi.director.application.autodoc.DocInfo.DocInfo	(	DBObject	record,
		DirectoryAccess	dir,
		String	nameAttr
	)		throws DirectorException

References sfi.director.application.autodoc.DocInfo.addAdjuncts(), sfi.director.application.autodoc.DocInfo.addClassInfo(), sfi.director.application.autodoc.DocInfo.directory(), and sfi.director.application.autodoc.DocInfo.docObject().

Member Function Documentation

void sfi.director.application.autodoc.DocInfo.addAdjuncts	(	DirectoryAccess	directory,
		DBObject	dbo
	)		throws DirectorException

add adjunct document objs for the given object

References sfi.director.application.autodoc.DocInfo.adjDocObjs(), sfi.director.application.autodoc.DocInfo.directory(), sfi.director.repository.config.DirectoryAccess.getDBConnection(), sfi.director.repository.DBConnection.search(), sfi.director.repository.DBConnection.SEARCH_BASEDN, sfi.director.repository.DBConnection.SEARCH_NOSUB, sfi.director.util.Options.setOption(), and sfi.director.repository.DBConnection.unwrap().

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

void sfi.director.application.autodoc.DocInfo.addAliasLabel

(

String

label

)

adds a label.

additional labels

References sfi.director.application.autodoc.DocInfo.aliasLabels().

Referenced by sfi.director.application.autodoc.DocInfo.genLabel().

void sfi.director.application.autodoc.DocInfo.addClassInfo

(

)

throws DirectorException

Slurp in documentation records from super classes.

References sfi.director.application.autodoc.DocInfo.adjDocObjs(), sfi.director.application.autodoc.DocInfo.docObject(), sfi.director.repository.DBObject.getAttribute(), and sfi.director.repository.config.Directory.getDirectory().

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

DocChapter sfi.director.application.autodoc.DocInfo.addIntroChapter	(	DocBuilder	builder,
		String	title[],
		DocCategory	category
	)		throws DirectorException

References sfi.director.application.autodoc.DocInfo.title().

Referenced by sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.application.autodoc.DocBuilder.genericObjDoc(), sfi.director.application.autodoc.DocBuilder.hostdoc(), sfi.director.application.autodoc.DocBuilder.insertDependencyGraph(), sfi.director.application.autodoc.DocBuilder.locationdoc(), sfi.director.application.autodoc.DocInfo.locationDocu(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

DocChapter sfi.director.application.autodoc.DocInfo.addIntroChapter	(	DocBuilder	builder,
		String	title[],
		DocCategory	category,
		boolean	onlyIfNotEmpty
	)		throws DirectorException

References sfi.director.application.autodoc.DocChapter.addFile(), sfi.director.application.autodoc.DocChapter.addImage(), sfi.director.application.autodoc.DocChapter.addRef(), sfi.director.application.autodoc.DocChapter.addText(), sfi.director.application.autodoc.DocChapter.aliasLabels, sfi.director.application.autodoc.DocInfo.aliasLabels(), sfi.director.application.autodoc.DocInfo.docObject(), sfi.director.application.autodoc.DocInfo.getDocOpts(), sfi.director.application.autodoc.DocInfo.getDocs(), sfi.director.application.autodoc.DocInfo.getImageOpts(), sfi.director.application.autodoc.DocInfo.getImages(), sfi.director.util.Options.getOption(), sfi.director.util.Options.getOptionInt(), sfi.director.repository.DBObject.getValue(), sfi.director.application.autodoc.DocInfo.label(), sfi.director.application.autodoc.DocChapter.label, sfi.director.application.autodoc.DocChapter.onlyIncludeIfReferred, sfi.director.application.autodoc.DocInfo.searchAndRevise(), sfi.director.application.autodoc.DocChapter.subheading, sfi.director.application.autodoc.DocInfo.title(), and sfi.director.application.autodoc.DocChapter.verbatim().

Vector sfi.director.application.autodoc.DocInfo.adjDocObjs

(

)

Accessor for attribute adjDocObjs.

Referenced by sfi.director.application.autodoc.DocInfo.addAdjuncts(), sfi.director.application.autodoc.DocInfo.addClassInfo(), sfi.director.application.autodoc.DocInfo.adjDocObjs(), sfi.director.application.autodoc.DocInfo.configFileSpecs(), sfi.director.application.autodoc.DocInfo.searchAndRevise(), and sfi.director.application.autodoc.DocInfo.searchFirst().

Vector sfi.director.application.autodoc.DocInfo.adjDocObjs

(

Vector

adjDocObjs

)

Mutator for attribute adjDocObjs.

References sfi.director.application.autodoc.DocInfo.adjDocObjs().

Vector sfi.director.application.autodoc.DocInfo.aliases

(

)

Accessor for attribute aliases.

aliases for this object. Alternative name().

Referenced by sfi.director.application.autodoc.DocInfo.aliases(), sfi.director.application.autodoc.DocInfo.docObject(), and sfi.director.application.autodoc.DocInfo.genLabel().

Vector sfi.director.application.autodoc.DocInfo.aliases

(

Vector

aliases

)

Mutator for attribute aliases.

aliases for this object. Alternative name().

References sfi.director.application.autodoc.DocInfo.aliases().

Vector sfi.director.application.autodoc.DocInfo.aliasLabels

(

)

Accessor for attribute aliasLabels.

additional labels

Referenced by sfi.director.application.autodoc.DocInfo.addAliasLabel(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), and sfi.director.application.autodoc.DocInfo.aliasLabels().

Vector sfi.director.application.autodoc.DocInfo.aliasLabels

(

Vector

aliasLabels

)

Mutator for attribute aliasLabels.

additional labels

References sfi.director.application.autodoc.DocInfo.aliasLabels().

Vector sfi.director.application.autodoc.DocInfo.configFileSpecs

(

)

throws DirectorException

Looking at the documentation objects build a list of config file specs found in the various objects.

The list entries are compatible with ConfigFile.addAlternativeSpec(). Computation is on a best-effort basis, no guarantee that the list is complete.

References sfi.director.application.autodoc.DocInfo.adjDocObjs(), sfi.director.repository.config.DirectoryAccess.get(), sfi.director.repository.DBObject.getAttribute(), and sfi.director.repository.config.Directory.getDirectory().

Referenced by sfi.director.application.autodoc.InfoCollector.remoteArguments().

int sfi.director.application.autodoc.DocInfo.detaillevel	(	DBObject	adjObject,
		int	defaultLevel
	)

References sfi.director.repository.DBObject.getValue().

DirectoryAccess sfi.director.application.autodoc.DocInfo.directory

(

)

Accessor for attribute directory.

The DirectoryAccess where the docObject is stored.

Referenced by sfi.director.application.autodoc.DocInfo.addAdjuncts(), sfi.director.application.autodoc.DocInfo.directory(), and sfi.director.application.autodoc.DocInfo.DocInfo().

DirectoryAccess sfi.director.application.autodoc.DocInfo.directory

(

DirectoryAccess

directory

)

Mutator for attribute directory.

The DirectoryAccess where the docObject is stored.

References sfi.director.application.autodoc.DocInfo.directory().

DBObject sfi.director.application.autodoc.DocInfo.docObject

(

)

Accessor for attribute docObject.

The (raw) DBObject we base our info on.

Referenced by sfi.director.application.autodoc.DocInfo.addClassInfo(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocInfo.DocInfo(), sfi.director.application.autodoc.DocInfo.docObject(), sfi.director.application.autodoc.DocInfo.genLabel(), sfi.director.application.autodoc.DocInfo.getDocOpts(), sfi.director.application.autodoc.DocInfo.getDocs(), sfi.director.application.autodoc.DocInfo.getImageOpts(), sfi.director.application.autodoc.DocInfo.getImages(), and sfi.director.application.autodoc.DocInfo.templateText().

DBObject sfi.director.application.autodoc.DocInfo.docObject

(

DBObject

docObject

)

Mutator for attribute docObject.

This also "computes" the name/title of the object by trying to find out which attribute is to be considered as the name. The (raw) DBObject we base our info on.

References sfi.director.application.autodoc.DocInfo.docObject().

DBObject sfi.director.application.autodoc.DocInfo.docObject	(	DBObject	docObject,
		String	nameAttr
	)

Set docObject and compute the name from the attribute with the given name.

@copydoc docObject

References sfi.director.application.autodoc.DocInfo.aliases(), sfi.director.application.autodoc.DocInfo.docObject(), sfi.director.application.autodoc.DocInfo.genLabel(), sfi.director.repository.DBObject.getAttribute(), sfi.director.repository.DBObject.getEValue(), sfi.director.repository.DBObject.getValue(), sfi.director.application.autodoc.DocInfo.name(), and sfi.director.application.autodoc.DocInfo.title().

void sfi.director.application.autodoc.DocInfo.genLabel

(

)

Generate a label for this object that can later be used to create references to it.

The label is composed of the name of the object type as registered via the ObjectRegistry and the name() of the object.

References sfi.director.application.autodoc.DocInfo.addAliasLabel(), sfi.director.application.autodoc.DocInfo.aliases(), sfi.director.application.autodoc.DocInfo.docObject(), sfi.director.util.ObjectRegistry.getByClass(), sfi.director.application.autodoc.DocInfo.label(), sfi.director.application.autodoc.DocInfo.name(), and sfi.director.util.Tools.uniqId().

Referenced by sfi.director.application.autodoc.DocInfo.docObject().

Vector sfi.director.application.autodoc.DocInfo.getDocOpts

(

)

get a Vector of doc Options, each option object is a pendant to the respective entry in getDocs().

References sfi.director.application.autodoc.DocInfo.docObject().

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocInfo.getDocOpts(), and sfi.director.application.autodoc.DocInfo.templateText().

Vector sfi.director.application.autodoc.DocInfo.getDocOpts

(

DBObject

doc

)

References sfi.director.application.autodoc.DocInfo.getDocOpts().

Vector sfi.director.application.autodoc.DocInfo.getDocOpts

(

String

attribute

)

get a Vector of Options out of the named attribute

References sfi.director.application.autodoc.DocInfo.docObject(), and sfi.director.application.autodoc.DocInfo.getDocOpts().

Vector sfi.director.application.autodoc.DocInfo.getDocOpts	(	DBObject	doc,
		String	attribute
	)

References sfi.director.repository.DBObject.getAttribute(), and sfi.director.util.Tools.split().

Vector sfi.director.application.autodoc.DocInfo.getDocs

(

)

get a Vector of doc URLs.

References sfi.director.application.autodoc.DocInfo.docObject().

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter().

Vector sfi.director.application.autodoc.DocInfo.getDocs

(

DBObject

doc

)

References sfi.director.repository.DBObject.getAttribute().

Vector sfi.director.application.autodoc.DocInfo.getImageOpts

(

)

get a Vector of image Options, each option object is a pendant to the respective entry in getImages().

References sfi.director.application.autodoc.DocInfo.docObject().

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter().

Vector sfi.director.application.autodoc.DocInfo.getImageOpts

(

DBObject

obj

)

References sfi.director.repository.DBObject.getAttribute(), and sfi.director.util.Tools.split().

Vector sfi.director.application.autodoc.DocInfo.getImages

(

)

get a Vector of image URLs.

References sfi.director.application.autodoc.DocInfo.docObject().

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter().

Vector sfi.director.application.autodoc.DocInfo.getImages

(

DBObject

obj

)

References sfi.director.repository.DBObject.getAttribute().

String sfi.director.application.autodoc.DocInfo.label

(

)

Accessor for attribute label.

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocInfo.genLabel(), and sfi.director.application.autodoc.DocInfo.label().

String sfi.director.application.autodoc.DocInfo.label

(

String

label

)

Mutator for attribute label.

References sfi.director.application.autodoc.DocInfo.label().

DBObject sfi.director.application.autodoc.DocInfo.location

(

)

References sfi.director.application.autodoc.DocInfo.searchFirst().

Referenced by sfi.director.application.autodoc.DocInfo.locationDocu().

void sfi.director.application.autodoc.DocInfo.locationDocu	(	DocBuilder	builder,
		DocChapter	parent,
		DocCategory	category
	)		throws DirectorException

References sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocInfo.DocInfo(), sfi.director.repository.DBObject.getValue(), and sfi.director.application.autodoc.DocInfo.location().

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

String sfi.director.application.autodoc.DocInfo.name

(

)

Accessor for attribute name.

The name/ID of the object. Initially set to reflect the appropriate docObject attr.

Referenced by sfi.director.application.autodoc.DocInfo.docObject(), sfi.director.application.autodoc.DocInfo.genLabel(), sfi.director.application.autodoc.DocInfo.name(), and sfi.director.application.autodoc.DocInfo.title().

String sfi.director.application.autodoc.DocInfo.name

(

String

name

)

Mutator for attribute name.

The name/ID of the object. Initially set to reflect the appropriate docObject attr.

References sfi.director.application.autodoc.DocInfo.name().

Vector sfi.director.application.autodoc.DocInfo.searchAndRevise

(

String

objectclass

)

Searches for information of the given type and applies rules for auto-scan objects.

Returns

list of resulting DBObject objects

References sfi.director.repository.DBObject.addUniqueAttributeIgnoreCase(), sfi.director.application.autodoc.DocInfo.adjDocObjs(), sfi.director.repository.DBObject.clone(), sfi.director.repository.DBSet.elementsVector(), sfi.director.repository.DBSet.get(), sfi.director.repository.DBObject.getAttribute(), sfi.director.repository.DBObject.getAttributes(), sfi.director.repository.DBSet.indexedGet(), sfi.director.repository.DBObject.isMember(), sfi.director.repository.DBSet.remove(), and sfi.director.repository.DBSet.replace().

Referenced by sfi.director.application.autodoc.DocBuilder.addDependencyGraph(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocBuilder.hostdoc(), and sfi.director.application.autodoc.DocBuilder.insertDependencyGraphs().

DBObject sfi.director.application.autodoc.DocInfo.searchFirst

(

String

objectclass

)

References sfi.director.application.autodoc.DocInfo.adjDocObjs(), and sfi.director.repository.DBObject.isMember().

Referenced by sfi.director.application.autodoc.DocInfo.location().

DBObject sfi.director.application.autodoc.DocInfo.templateParams

(

)

Accessor for attribute templateParams.

the parameter/values to be filled in templates

Referenced by sfi.director.application.autodoc.DocInfo.templateParams(), and sfi.director.application.autodoc.DocInfo.templateText().

DBObject sfi.director.application.autodoc.DocInfo.templateParams

(

DBObject

templateParams

)

Mutator for attribute templateParams.

the parameter/values to be filled in templates

References sfi.director.application.autodoc.DocInfo.templateParams().

String sfi.director.application.autodoc.DocInfo.templateText

(

)

References sfi.director.application.autodoc.DocInfo.docObject(), sfi.director.util.Tools.expand(), sfi.director.repository.DBObject.getAttribute(), sfi.director.application.autodoc.DocInfo.getDocOpts(), sfi.director.application.autodoc.DocBuilder.mediafile(), and sfi.director.application.autodoc.DocInfo.templateParams().

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRefWithTemplate().

String sfi.director.application.autodoc.DocInfo.title

(

)

Accessor for attribute title.

The title of the object. This is often the same as the name(), but not always.

References sfi.director.application.autodoc.DocInfo.name().

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocInfo.docObject(), and sfi.director.application.autodoc.DocInfo.title().

String sfi.director.application.autodoc.DocInfo.title

(

String

title

)

Mutator for attribute title.

The title of the object. This is often the same as the name(), but not always.

References sfi.director.application.autodoc.DocInfo.title().

Member Data Documentation

Vector sfi.director.application.autodoc.DocInfo.adjDocObjs = new Vector()

protected

Referenced by sfi.director.application.autodoc.DocInfo.addClassInfo().

Vector sfi.director.application.autodoc.DocInfo.aliases = new Vector()

protected

aliases for this object. Alternative name().

Vector sfi.director.application.autodoc.DocInfo.aliasLabels = new Vector()

protected

additional labels

DirectoryAccess sfi.director.application.autodoc.DocInfo.directory = null

protected

The DirectoryAccess where the docObject is stored.

DBObject sfi.director.application.autodoc.DocInfo.docObject = null

protected

The (raw) DBObject we base our info on.

Cache sfi.director.application.autodoc.DocInfo.infoCache = new Cache( 120, 120 )

protected

String sfi.director.application.autodoc.DocInfo.label = null

protected

Referenced by sfi.director.application.autodoc.DocBuilder.haveChapterFor(), sfi.director.application.autodoc.DocBuilder.hostdoc(), and sfi.director.application.autodoc.DocBuilder.insertDependencyGraph().

String sfi.director.application.autodoc.DocInfo.name = null

protected

The name/ID of the object. Initially set to reflect the appropriate docObject attr.

Referenced by sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.application.autodoc.DocBuilder.genericObjDoc(), sfi.director.application.autodoc.DocBuilder.hostdoc(), sfi.director.application.autodoc.DocBuilder.insertDependencyGraph(), sfi.director.application.autodoc.DocBuilder.locationdoc(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

DBObject sfi.director.application.autodoc.DocInfo.templateParams = null

protected

the parameter/values to be filled in templates

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

String sfi.director.application.autodoc.DocInfo.title = null

protected

The title of the object. This is often the same as the name(), but not always.

Referenced by sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.application.autodoc.DocBuilder.genericObjDoc(), sfi.director.application.autodoc.DocBuilder.hostdoc(), sfi.director.application.autodoc.DocBuilder.insertDependencyGraph(), sfi.director.application.autodoc.DocBuilder.locationdoc(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

---

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

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