sfi.director.application.autodoc.DocBuilder Class Reference

List of all members.

---

Detailed Description

Builds documentation from the information in the configuration repository.

Public Member Functions
	DocBuilder () throws DirectorException
	DocBuilder (String audience) throws DirectorException
void	generate (String filename, String format) throws DirectorException
	output the documentation formerly built by build()
void	build () throws DirectorException
	build the entire documentation.
void	genRawDoc ()
	Makes raw xhtml from the current chapters.
void	slurpExternalDocs () throws DirectorException
void	sortChapters ()
	Sort chapters so that they appear in the chapters Vector in the same order they will appear in the final document.
String	rawText ()
void	makeStructure ()
	Add missing chapters / levels.
void	genericDocu (String directoryName, String chapterTitle, String chapterSubtitle, String intro) throws DirectorException
void	genericDocu (String directoryName, String chapterTitle, String chapterSubtitle, String intro, boolean includeInServiceTree) throws DirectorException
	build the documentation for generic documentation elements.
void	genericObjDoc (DBObject obj, String directoryName, DocChapter masterChapter, boolean includeInServiceTree) throws DirectorException
	build the documentation for a single generic object
void	users () throws DirectorException
	build the documentation for users
void	concepts () throws DirectorException
	build the documentation for Concepts
void	tools () throws DirectorException
	build the documentation for Tools
void	components () throws DirectorException
	build the documentation for Components
void	suppliers () throws DirectorException
	build the documentation for Suppliers
void	contracts () throws DirectorException
	build the documentation for Contracts
void	services () throws DirectorException
	build the documentation for Services
void	software () throws DirectorException
	build the documentation for Software
void	locations () throws DirectorException
	build the documentation for Locations
void	locationdoc (DBObject location) throws DirectorException
	build the documentation for a single domain
void	domaindoc () throws DirectorException
	build the documentation for DSDomains
void	domaindoc (DBObject domain) throws DirectorException
	build the documentation for a single domain
void	hostdoc () throws DirectorException
	build the documentation for all hosts.
void	hostdoc (String name) throws DirectorException
	build the documentation for one single, named host.
void	hostdoc (DBObject host) throws DirectorException
	build the documentation for one single host, given its host DBObject.
void	configfilesdoc ()
void	configfilesdoc (Vector cfgCollection)
void	insertDependencyGraphs () throws DirectorException
void	insertDependencyGraph (DocInfo info, DBObject graphdef, DocChapter parentChapter, DocCategory category) throws DirectorException
boolean	haveChapterFor (DocInfo what)
	Test if a chapter for the DocInfo object already exists.
Hashtable	chapterIndex ()
	Accessor for attribute chapterIndex.
Hashtable	chapterIndex (Hashtable chapterIndex)
	Mutator for attribute chapterIndex.
Vector	chapters ()
	Accessor for attribute chapters.
Vector	chapters (Vector chapters)
	Mutator for attribute chapters.
void	addChapter (DocChapter chapter)
	Add a chapter.
DocChapter	addMasterChapter (String heading, String subheading, String filename) throws DirectorException
	Create and add a chapter with heading and subheading, read contents from a file.
DocChapter	getChapter (DocChapter like)
	Search for an existing chapter by a DocChapter with the same title.
DocChapter	getChapterById (String id)
	Search for an existing chapter by a DocChapter ID.
DocChapter	getChapter (String label)
	Search for an existing chapter by its label.
boolean	isReferred (String ref)
	check if a reference is referred to in one of the existing chapters.
String	audience ()
	Accessor for attribute audience.
String	audience (String audience)
	Mutator for attribute audience.
boolean	testMode ()
	Accessor for attribute testMode.
boolean	testMode (boolean testMode)
	Mutator for attribute testMode.
Vector	dependencyGraphs ()
	Accessor for attribute dependencyGraphs.
void	addDependencyGraph (DocInfo info, DocChapter parent, DocCategory category)
	Add dependencyGraphs.
Vector	configfiles ()
	Accessor for attribute configfiles.
void	addConfigFile (ConfigFile configfile)
	Mutator for attribute configfiles.
String	addMediaFile (String fname)
void	copyMedia (File target) throws DirectorException, IOException
void	mkMediaFrom (String text, File mediaFile) throws DirectorException
void	cleanDocMedia () throws DirectorException
Static Public Member Functions
static String	readableTime (long time)
static String	readableTime (Date time)
static File	mediafile (String filename)
	Helper function - return a file within the docmedia dir.
static String	humanReadableSize (long bytes)
Public Attributes
ServiceDepContainer	serviceTree = new ServiceDepContainer()
Protected Member Functions
String	_shortMediaName (int i, String filename)
int	nextId ()
	returns a unique identifier.
File	nextPath ()
	returns a unique file.
Protected Attributes
TempFile	tmpdir = TempFile.create( "docbuild" )
StringBuffer	rawText = new StringBuffer()
Hashtable	chapterIndex = new Hashtable()
	index chapter title => chapter
Hashtable	chapterIndexByLabel = new Hashtable()
	index chapter label => chapter
Vector	chapters = new Vector()
	set of chapters
String	audience = "public"
	The target audience we build the documentation for.
boolean	testMode = false
	If set, only partial doc is built.
Vector	dependencyGraphs = new Vector()
	List of dependency graphs.
Vector	configfiles = new Vector()
	List of ConfigFiles.
Vector	media = new Vector()
Static Package Attributes
static final String	text_hosts = "Hosts"
static final String	text_hosts_sub = "Computers and other hardware devices"
static final String	text_domains = "Name Service Domains"
static final String	text_domains_sub = "Directory information conversion and update rules"
static final String	text_general = "General"
static final String	text_summary = "Summary"
static final String	text_ipaddress = "IP Address"
static final String	text_macaddress = "MAC Address"
static final String	text_assignedhosts = "Assigned Hosts"
static final String	text_locations = "Locations"
static final String	text_locations_sub = "Geographical Locations"
static final String	text_contracts = "Contracts and Agreements"
static final String	text_contracts_sub = "SLAs, service and support contracts, etc."
static final String	text_suppliers = "Suppliers"
static final String	text_suppliers_sub = "Component suppliers, contractors"
static final String	text_components = "Components"
static final String	text_components_sub = "Hardware components, devices, computers"
static final String	text_concepts = "Concepts"
static final String	text_concepts_sub = "General overview"
static final String	text_tools = "Tools and Processes"
static final String	text_tools_sub = "Best Practice, Tools and Utilities, Workflows and Processes"
static final String	text_location = "Location"
static final String	text_domain_rules = "Domain Build Rules"
static final String	text_domain_targets = "Targets"
static final String	text_domainlist = "Domains"
static final String	text_services = "Services"
static final String	text_services_sub = "System services"
static final String	text_software = "Software"
static final String	text_software_sub = "Application Software"
static final String	text_users = "Users"
static final String	text_users_sub = ""
static final String	text_documents = "Documents"

---

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocBuilder.DocBuilder (   )  throws DirectorException

sfi.director.application.autodoc.DocBuilder.DocBuilder (  String  audience  )  throws DirectorException

---

Member Function Documentation

String sfi.director.application.autodoc.DocBuilder._shortMediaName (  int  i, String  filename )  [protected]

void sfi.director.application.autodoc.DocBuilder.addChapter (  DocChapter  chapter  )

Add a chapter. Note: that neither title nor label must be modified after the chapter has been added

void sfi.director.application.autodoc.DocBuilder.addConfigFile (  ConfigFile  configfile  )

Mutator for attribute configfiles. List of ConfigFiles. During the docu generation ConfigFile objects are piled up in this Vector by the various steps. At the end of the process they are flushed and inserted into the docu by configfiles() *

void sfi.director.application.autodoc.DocBuilder.addDependencyGraph (  DocInfo  info, DocChapter  parent, DocCategory  category )

Add dependencyGraphs. List of dependency graphs. During docu creation, graphs pending rendering are piled up in this Vector. At the end of the process they are flushed and inserted into the docu by insertDepGraphs(). That's because dependencies are collected during documentation processing and thus, dependency information is only complete at the end of processing.

DocChapter sfi.director.application.autodoc.DocBuilder.addMasterChapter (  String  heading, String  subheading, String  filename )  throws DirectorException

Create and add a chapter with heading and subheading, read contents from a file.

String sfi.director.application.autodoc.DocBuilder.addMediaFile (  String  fname  )

String sfi.director.application.autodoc.DocBuilder.audience (  String  audience  )

Mutator for attribute audience. The target audience we build the documentation for. This has influence on the detail level and is usually also used for preventing internal information to be revealed to the public.

String sfi.director.application.autodoc.DocBuilder.audience (   )

Accessor for attribute audience. The target audience we build the documentation for. This has influence on the detail level and is usually also used for preventing internal information to be revealed to the public.

void sfi.director.application.autodoc.DocBuilder.build (   )  throws DirectorException

build the entire documentation.

Hashtable sfi.director.application.autodoc.DocBuilder.chapterIndex (  Hashtable  chapterIndex  )

Mutator for attribute chapterIndex. index chapter title => chapter

Hashtable sfi.director.application.autodoc.DocBuilder.chapterIndex (   )

Accessor for attribute chapterIndex. index chapter title => chapter

Vector sfi.director.application.autodoc.DocBuilder.chapters (  Vector  chapters  )

Mutator for attribute chapters. set of chapters

Vector sfi.director.application.autodoc.DocBuilder.chapters (   )

Accessor for attribute chapters. set of chapters

void sfi.director.application.autodoc.DocBuilder.cleanDocMedia (   )  throws DirectorException

void sfi.director.application.autodoc.DocBuilder.components (   )  throws DirectorException

build the documentation for Components

void sfi.director.application.autodoc.DocBuilder.concepts (   )  throws DirectorException

build the documentation for Concepts

Vector sfi.director.application.autodoc.DocBuilder.configfiles (   )

Accessor for attribute configfiles. List of ConfigFiles. During the docu generation ConfigFile objects are piled up in this Vector by the various steps. At the end of the process they are flushed and inserted into the docu by configfiles() *

void sfi.director.application.autodoc.DocBuilder.configfilesdoc (  Vector  cfgCollection  )

void sfi.director.application.autodoc.DocBuilder.configfilesdoc (   )

void sfi.director.application.autodoc.DocBuilder.contracts (   )  throws DirectorException

build the documentation for Contracts

void sfi.director.application.autodoc.DocBuilder.copyMedia (  File  target  )  throws DirectorException, IOException

Vector sfi.director.application.autodoc.DocBuilder.dependencyGraphs (   )

Accessor for attribute dependencyGraphs. List of dependency graphs. During docu creation, graphs pending rendering are piled up in this Vector. At the end of the process they are flushed and inserted into the docu by insertDepGraphs(). That's because dependencies are collected during documentation processing and thus, dependency information is only complete at the end of processing.

void sfi.director.application.autodoc.DocBuilder.domaindoc (  DBObject  domain  )  throws DirectorException

build the documentation for a single domain

void sfi.director.application.autodoc.DocBuilder.domaindoc (   )  throws DirectorException

build the documentation for DSDomains

void sfi.director.application.autodoc.DocBuilder.generate (  String  filename, String  format )  throws DirectorException

output the documentation formerly built by build()

void sfi.director.application.autodoc.DocBuilder.genericDocu (  String  directoryName, String  chapterTitle, String  chapterSubtitle, String  intro, boolean  includeInServiceTree )  throws DirectorException

build the documentation for generic documentation elements. The generic docu is applicable for those elements that actually do not need special functionality - they merely consist of manual docu

void sfi.director.application.autodoc.DocBuilder.genericDocu (  String  directoryName, String  chapterTitle, String  chapterSubtitle, String  intro )  throws DirectorException

void sfi.director.application.autodoc.DocBuilder.genericObjDoc (  DBObject  obj, String  directoryName, DocChapter  masterChapter, boolean  includeInServiceTree )  throws DirectorException

build the documentation for a single generic object

void sfi.director.application.autodoc.DocBuilder.genRawDoc (   )

Makes raw xhtml from the current chapters. The result of this is is not a nicely formatted HTML document. Note: as a side effect this method does re-sort the chapter() Vector so that it contains the chapters in the same order they appear in the document.

DocChapter sfi.director.application.autodoc.DocBuilder.getChapter (  String  label  )

Search for an existing chapter by its label.

DocChapter sfi.director.application.autodoc.DocBuilder.getChapter (  DocChapter  like  )

Search for an existing chapter by a DocChapter with the same title.

DocChapter sfi.director.application.autodoc.DocBuilder.getChapterById (  String  id  )

Search for an existing chapter by a DocChapter ID.

boolean sfi.director.application.autodoc.DocBuilder.haveChapterFor (  DocInfo  what  )

Test if a chapter for the DocInfo object already exists.

void sfi.director.application.autodoc.DocBuilder.hostdoc (  DBObject  host  )  throws DirectorException

build the documentation for one single host, given its host DBObject.

void sfi.director.application.autodoc.DocBuilder.hostdoc (  String  name  )  throws DirectorException

build the documentation for one single, named host.

void sfi.director.application.autodoc.DocBuilder.hostdoc (   )  throws DirectorException

build the documentation for all hosts.

static String sfi.director.application.autodoc.DocBuilder.humanReadableSize (  long  bytes  )  [static]

void sfi.director.application.autodoc.DocBuilder.insertDependencyGraph (  DocInfo  info, DBObject  graphdef, DocChapter  parentChapter, DocCategory  category )  throws DirectorException

void sfi.director.application.autodoc.DocBuilder.insertDependencyGraphs (   )  throws DirectorException

boolean sfi.director.application.autodoc.DocBuilder.isReferred (  String  ref  )

check if a reference is referred to in one of the existing chapters.

void sfi.director.application.autodoc.DocBuilder.locationdoc (  DBObject  location  )  throws DirectorException

build the documentation for a single domain

void sfi.director.application.autodoc.DocBuilder.locations (   )  throws DirectorException

build the documentation for Locations

void sfi.director.application.autodoc.DocBuilder.makeStructure (   )

Add missing chapters / levels. The diverse content generating procedures are allowed to add chapters at the level they wish without caring for the parent chapters to exist. This procedure adds missing parents.

static File sfi.director.application.autodoc.DocBuilder.mediafile (  String  filename  )  [static]

Helper function - return a file within the docmedia dir.

void sfi.director.application.autodoc.DocBuilder.mkMediaFrom (  String  text, File  mediaFile )  throws DirectorException

int sfi.director.application.autodoc.DocBuilder.nextId (   )  [protected]

returns a unique identifier. Use this e.g. in order to name generated media files.

File sfi.director.application.autodoc.DocBuilder.nextPath (   )  [protected]

returns a unique file.

String sfi.director.application.autodoc.DocBuilder.rawText (   )

static String sfi.director.application.autodoc.DocBuilder.readableTime (  Date  time  )  [static]

static String sfi.director.application.autodoc.DocBuilder.readableTime (  long  time  )  [static]

void sfi.director.application.autodoc.DocBuilder.services (   )  throws DirectorException

build the documentation for Services

void sfi.director.application.autodoc.DocBuilder.slurpExternalDocs (   )  throws DirectorException

void sfi.director.application.autodoc.DocBuilder.software (   )  throws DirectorException

build the documentation for Software

void sfi.director.application.autodoc.DocBuilder.sortChapters (   )

Sort chapters so that they appear in the chapters Vector in the same order they will appear in the final document.

void sfi.director.application.autodoc.DocBuilder.suppliers (   )  throws DirectorException

build the documentation for Suppliers

boolean sfi.director.application.autodoc.DocBuilder.testMode (  boolean  testMode  )

Mutator for attribute testMode. If set, only partial doc is built.

boolean sfi.director.application.autodoc.DocBuilder.testMode (   )

Accessor for attribute testMode. If set, only partial doc is built.

void sfi.director.application.autodoc.DocBuilder.tools (   )  throws DirectorException

build the documentation for Tools

void sfi.director.application.autodoc.DocBuilder.users (   )  throws DirectorException

build the documentation for users

---

Member Data Documentation

String sfi.director.application.autodoc.DocBuilder.audience = "public" [protected]

The target audience we build the documentation for. This has influence on the detail level and is usually also used for preventing internal information to be revealed to the public.

Hashtable sfi.director.application.autodoc.DocBuilder.chapterIndex = new Hashtable() [protected]

index chapter title => chapter

Hashtable sfi.director.application.autodoc.DocBuilder.chapterIndexByLabel = new Hashtable() [protected]

index chapter label => chapter

Vector sfi.director.application.autodoc.DocBuilder.chapters = new Vector() [protected]

set of chapters

Vector sfi.director.application.autodoc.DocBuilder.configfiles = new Vector() [protected]

List of ConfigFiles. During the docu generation ConfigFile objects are piled up in this Vector by the various steps. At the end of the process they are flushed and inserted into the docu by configfiles() *

Vector sfi.director.application.autodoc.DocBuilder.dependencyGraphs = new Vector() [protected]

List of dependency graphs. During docu creation, graphs pending rendering are piled up in this Vector. At the end of the process they are flushed and inserted into the docu by insertDepGraphs(). That's because dependencies are collected during documentation processing and thus, dependency information is only complete at the end of processing.

Vector sfi.director.application.autodoc.DocBuilder.media = new Vector() [protected]

StringBuffer sfi.director.application.autodoc.DocBuilder.rawText = new StringBuffer() [protected]

ServiceDepContainer sfi.director.application.autodoc.DocBuilder.serviceTree = new ServiceDepContainer()

boolean sfi.director.application.autodoc.DocBuilder.testMode = false [protected]

If set, only partial doc is built.

final String sfi.director.application.autodoc.DocBuilder.text_assignedhosts = "Assigned Hosts" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_components = "Components" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_components_sub = "Hardware components, devices, computers" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_concepts = "Concepts" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_concepts_sub = "General overview" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_contracts = "Contracts and Agreements" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_contracts_sub = "SLAs, service and support contracts, etc." [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_documents = "Documents" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_domain_rules = "Domain Build Rules" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_domain_targets = "Targets" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_domainlist = "Domains" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_domains = "Name Service Domains" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_domains_sub = "Directory information conversion and update rules" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_general = "General" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_hosts = "Hosts" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_hosts_sub = "Computers and other hardware devices" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_ipaddress = "IP Address" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_location = "Location" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_locations = "Locations" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_locations_sub = "Geographical Locations" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_macaddress = "MAC Address" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_services = "Services" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_services_sub = "System services" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_software = "Software" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_software_sub = "Application Software" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_summary = "Summary" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_suppliers = "Suppliers" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_suppliers_sub = "Component suppliers, contractors" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_tools = "Tools and Processes" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_tools_sub = "Best Practice, Tools and Utilities, Workflows and Processes" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_users = "Users" [static, package]

final String sfi.director.application.autodoc.DocBuilder.text_users_sub = "" [static, package]

TempFile sfi.director.application.autodoc.DocBuilder.tmpdir = TempFile.create( "docbuild" ) [protected]

---

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

• director/application/autodoc/DocBuilder.java

---