project35.mda.model
Class ModelObjectCommentRegistry

java.lang.Object
  project35.mda.model.ModelObjectCommentRegistry

public class ModelObjectCommentRegistry
extends java.lang.Object

this associates comments with record model objects. This is a new feature as of Project35 v1.9 and it may be used by plugins as well as Project35's alerts system. Right now it isn't much different than a HashMap but its class name and method names are far easier to understand than a hash map. This has been used in TabletProject35 to associate record model objects with comments that come from validation or plugins. It hasn't yet been incorporated into Desktop Project35 but will in future.

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Constructor Summary

ModelObjectCommentRegistry()

Method Summary

void	clear()
void	clearComments()
void	clearComments(java.lang.Object userObject)
java.lang.String[]	getComments(java.lang.Object nativeDataStructure, java.lang.Object userObject)
DataFieldModel[]	getFieldsWithComments(RecordNameProvider recordNameProvider)
java.lang.String	getHTMLComments(java.lang.Object nativeDataStructure)
java.lang.String	getHTMLComments(java.lang.Object nativeDataStructure, java.lang.Object userObject)
int	getNumberOfEntries(java.lang.Object userObject)
RecordNameProvider[]	getRecordsWithComments()
RecordNameProvider[]	getRecordsWithComments(java.lang.Object userObject)
void	registerComment(java.lang.Object nativeDataStructure, java.lang.String comment)
void	registerComment(java.lang.Object nativeDataStructure, java.lang.String comment, java.lang.Object userObject)
void	registerComment(java.lang.String comment)
void	setCurrentCommentObject(java.lang.Object currentCommentObject)
void	setCurrentUserObject(java.lang.Object userObject)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelObjectCommentRegistry

public ModelObjectCommentRegistry()

Method Detail

getRecordsWithComments

public RecordNameProvider[] getRecordsWithComments()

getRecordsWithComments

public RecordNameProvider[] getRecordsWithComments(java.lang.Object userObject)

getFieldsWithComments

public DataFieldModel[] getFieldsWithComments(RecordNameProvider recordNameProvider)

getHTMLComments

public java.lang.String getHTMLComments(java.lang.Object nativeDataStructure)

getComments

public java.lang.String[] getComments(java.lang.Object nativeDataStructure,
                                      java.lang.Object userObject)

getHTMLComments

public java.lang.String getHTMLComments(java.lang.Object nativeDataStructure,
                                        java.lang.Object userObject)

registerComment

public void registerComment(java.lang.String comment)

registerComment

public void registerComment(java.lang.Object nativeDataStructure,
                            java.lang.String comment)

registerComment

public void registerComment(java.lang.Object nativeDataStructure,
                            java.lang.String comment,
                            java.lang.Object userObject)

clear

public void clear()

clearComments

public void clearComments()

clearComments

public void clearComments(java.lang.Object userObject)

getNumberOfEntries

public int getNumberOfEntries(java.lang.Object userObject)

setCurrentCommentObject

public void setCurrentCommentObject(java.lang.Object currentCommentObject)

setCurrentUserObject

public void setCurrentUserObject(java.lang.Object userObject)