org.activemath.abstractcontent
Interface AuthorExtendedMBaseRef

All Superinterfaces:

MBaseRef

All Known Implementing Classes:

OJXmlRpcMBaseRef, OmdocLuceneMBaseRef, SluMBaseRef, SluMBaseRefForTesting

public interface AuthorExtendedMBaseRef
extends MBaseRef

Nested Class Summary

Nested classes/interfaces inherited from interface org.activemath.abstractcontent.MBaseRef

MBaseRef.Dependency, MBaseRef.Relation

Method Summary

Hashtable	getOMDocPath(MBaseID id)
void	reload(Collection collections) Works only with OmdocJdomMBaseRef and OmdocLuceneMBaseRef.
void	reloadWithErrors(Collection collections, List errorAccumulator) Reloads the content from the directory (optional operation).
Iterator	searchIDs(String idSubstring) Searches for an id by substring...

Methods inherited from interface org.activemath.abstractcontent.MBaseRef

assertItsUp, getAttribute, getCanonicalID, getChildren, getCollectionsProvided, getCommonName, getCompleteDCMetadata, getDefinitions, getDependencies, getFormalContent, getForWhat, getIncomingRelations, getItemsModifiedSince, getLastModified, getMetadata, getOutgoingRelations, getProofs, getRelated, getStructuredListOfConcepts, getTagFreeCommonName, getTextualContent, getTheory, getTypeString, listItems, listItems, listTheories, searchText

Method Detail

getOMDocPath

Hashtable getOMDocPath(MBaseID id)
                       throws MBaseException

Parameters:

id - The ID to be found

Returns:

A table with keys

• path, the path relative to the basePath.
• lineNumber the line-number in the file
• columnNumber the column-number in the file

absolutePath the absolute path to the file (optional)

Throws:

MBaseItemNotFoundException - if the ID is not found

MBaseException - If anything happens,

searchIDs

Iterator searchIDs(String idSubstring)
                   throws MBaseException

Searches for an id by substring...

Parameters:

idSubstring - The substring to search (may be empty to get a complete but expectedly hige list)

Returns:

The list of IDs that match (as MBaseIDs)

Throws:

MBaseException

reload

void reload(Collection collections)
            throws Exception

Works only with OmdocJdomMBaseRef and OmdocLuceneMBaseRef.

Parameters:

collections - The set of collection-names (Strings) to be reloaded (might be ignored by some implementations)

Throws:

Exception - if anything

reloadWithErrors

void reloadWithErrors(Collection collections,
                      List errorAccumulator)
                      throws Exception

Reloads the content from the directory (optional operation).

Parameters:

collections - The set of collection-names (Strings) tobe reloaded

errorAccumulator - a place to accumulate errors reported by the reload process each entry should be a Hashtable with keys

• "message" for the text of the exception
• "exceptionClass"
"collection": the collection-name of the file where the error happened "itemId": the mbase-id of the item containing where the error happened "systemId": the absolute path to the error's file location
• "relativePath": the path relative to the configured server root or collection root
• "lineNumber": the line-number within the file of the error location
• "columnNumber": the column-number within the file of the error location

Throws:

Exception