MONK : Hackfest MONK Components

This page last changed on Sep 24, 2007 by amitku.

MONK Proxy Calls Summary
Existing and don't need modification
ProjectManager.getProjectInfo
ProjectManager.getWorkSets
ProjectManager.saveWorkSet
ProjectManager.createNewWorkSet
ProjectManager.deleteWorkset
ProjectsManager.getJobIdForWorkset
ProjectsManager.createProject
ProjectsManager.deleteProject
D2KManager.runFakeAnalysis
D2KManager.runAnalysis
D2KManager.getJobStatus
D2KManager.getApproxTime
D2KManager.abortJob
D2KManager.getPrediction
D2KManager.getGraph
D2KManager.getFeatures
D2KManager.getFeatureChart
CollectionsManager.getChunksContainingFeature
CollectionsManager.getWorksetHierarchy

Existing but need modification
CollectionManager.getCollections. Add DocCount for FeatureLens.
CollectionManager.getChunkHierarchy. Choose how many levels down to go: either me and my child; or me and everything under me.
CollectionManager.renderChunkWithFeatures with the AsHTML parameter: We should be able to use this for FeatureLens in place of Hilight Pattern.

New
CollectionManager.getCollectionsMetaData(All). Return all METS metadata.
CollectionManager.getCollectionsMetaData(Behaviour). Return selected METS.
CollectionManager.getCollectionsMetaData(Genre).
CollectionManager.getCollectionsMetaData(StructureMap, ParentChunkType).
Returns nodes for first children labels and sizes.
Continue this list for all Dublin Core Collections Tags
Type (= genre)
Collection ID
Alternative title
Description
Size
Language
Format
Rights
Access Rights
Audience
Subject
Spatial Coverage (= geography)
Sub-collection
Super-collection
Associated collection
Owner
Creator
Keyword
CollectionManager.getDocumentMetadata(All, ChunkID1, ChunkID2...)
CollectionManager.getDocumentMetadata(Author, ChunkID1, ChunkID2...)
CollectionManager.getDocumentMetadata(Genre, ChunkID1, ChunkID2...)
The possible parameter list is the TEISimple header.
CollectionManager.getChunkCount: Return node count for just my immediate children, and a node count for everything beneath me.
CollectionManager.searchCollectionsMetadata
CollectionManager.searchFulltext: Lucene-style search.
D2KManager.SearchInFeatures
LogManager.saveLogs(Messages, TransactionID)
CollectionManager.GetSupportedAlgorithms(collectionID)
D2KManager.GetAlgorithmParameterList(algorithmID). Returns labels and maybe a default value for each variable, maybe a list to choose from.

Add these messages. They may differ for each component type. For instance, a collection sort would be different from a feature list sort.
Sort
Group
Intersection
Union

Current messages
ProjectManager.getProjectInfo
ProjectManager.getWorkSets
ProjectManager.saveWorkSet
ProjectManager.createNewWorkSet
ProjectManager.deleteWorkset
ProjectsManager.getJobIdForWorkset
ProjectsManager.createProject
ProjectsManager.deleteProject

2. COLLECTION DISPLAY AND SELECTION
List
Treemap
Spacetree
Lens
Current messages
CollectionManager.getCollections. Returns ID, Collection label for display, list of types of chunks.
Modify this: We need to return a DocCount for FeatureLens to use this call.

Add these messages
CollectionManager.getCollectionsMetaData(All). Return all METS metadata.
CollectionManager.getCollectionsMetaData(Behaviour). Return selected METS.
CollectionManager.getCollectionsMetaData(Genre).
CollectionManager.getCollectionsMetaData(StructureMap, ParentChunkType).
Returns nodes for first children labels and sizes.
.....

Metadata Discussion

Further discussion on the Collection Level Metadata is taking place here https://apps.lis.uiuc.edu/wiki/display/MONK/Collection+Metadata+Group

Descriptive Metadata: we can use Dublin Core
Administrative Metadata: property rights, subscriptions (technical, intellectual, source, provenance)
File Groups: to get sizes
Structural Map: chunk data
Behavior: list of possible behaviours, so we can, for instance, turns cards off and on

Dublin Core for Collections
Dublin Core Collections Application Profile Summary
Type = genre
Collection ID
Alternative title
Description
Size
Language
Format
Rights
Access Rights
Audience
Subject
Spatial Coverage = geography
Sub-collection
Super-collection
Associated collection
Owner
Creator
Keyword

3. DOCUMENT DISPLAY AND SELECTION
We would need to add this.
CollectionManager.getDocumentMetadata(All, ChunkID1, ChunkID2...)
CollectionManager.getDocumentMetadata(Author, ChunkID1, ChunkID2...)
CollectionManager.getDocumentMetadata(Genre, ChunkID1, ChunkID2...)
The possible parameter list is the TEISimple header.

4. CHUNK LIST DISPLAY AND SELECTION
Current messages
CollectionManager.getChunk(chunkID, collectionID, chunkType, renderAsHtml)
CollectionManager.getChunkHierarchy: Nested tree of collectionID with chunktype (e.g. work, chapter, vol, para, section), chunklabel

Modify this:
Choose how many levels down to go
Either me and my child; or me and everything under me

Add these messages
CollectionManager.getChunkCount: Return node count for just my immediate children, and a node count for everything beneath me.

5. TEXT VIEWER
Current messages
CollectionManager.renderChunkWithFeatures with the AsHTML parameter

Modify this:
We should be able to use this for FeatureLens in place of Hilight Pattern.

6. SEARCH AND BROWSE
Standard search
Current messages
CollectionManager.renderChunkwithFeatures. Searches within a document.
Returns a rendered HTML document with colour-coded words that you've searched for.

Add these messages
CollectionManager.searchCollectionsMetadata
CollectionManager.searchFulltext: Lucene-style search.
D2KManager.SearchInFeatures.

7. RATINGS CHOICE AND SELECTION
Rate listed items in the list
Rate current document in the document viewer
Current messages
D2KManager.runFakeAnalysis
D2KManager.runAnalysis
D2KManager.getJobStatus
D2KManager.getApproxTime
D2KManager.abortJob
D2KManager.getPrediction

Add these messages
CollectionManager.GetSupportedAlgorithms(collectionID)
D2KManager.GetAlgorithmParameterList(algorithmID). Returns labels and maybe a default value for each variable, maybe a list to choose from.

9. RESULT VISUALIZATION
FeatureLens graph
FeatureLens feature highlight in documents
Social network graph
Spiral plot of features from NORA
Timeline

Current messages
D2KManager.getGraph
D2KManager.getFeatures
D2KManager.getFeatureChart

Add these messages
logManager.SaveLogs(Messages, TransactionID)
Returns TransactionID, then for every message that was logged, we also get a datestamp, userID