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.
|
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 ) |
