[CIShell-SVN] SF.net SVN: cishell:[1236] trunk/core/org.cishell.utility.datastructure/src /org/cishell/utility/datastructure/datamodel

[<pat...@us...>]

Revision: 1236
          http://cishell.svn.sourceforge.net/cishell/?rev=1236&view=rev
Author:   pataphil
Date:     2011-03-07 19:18:57 +0000 (Mon, 07 Mar 2011)

Log Message:
-----------
* Documentation.

Modified Paths:
--------------
    trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/ModelDataSynchronizer.java
    trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/AbstractDataModelArea.java
    trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelArea.java
    trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelAreaContainer.java
    trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/field/DataModelFieldContainer.java
    trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/group/DataModelGroup.java
    trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/gui/AbstractGUIDataModel.java

Modified: trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/ModelDataSynchronizer.java
===================================================================
--- trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/ModelDataSynchronizer.java	2011-03-07 11:33:16 UTC (rev 1235)
+++ trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/ModelDataSynchronizer.java	2011-03-07 19:18:57 UTC (rev 1236)
@@ -1,7 +1,8 @@
 package org.cishell.utility.datastructure.datamodel;
 
-/**
- * 
+/** ModelDataSynchronizer<T> is an interface for synchronizing DataModelFields to their actual
+ * GUI widgets. For this reason, most or all implementations of this interface will be
+ * GUI-specific.
  */
 public interface ModelDataSynchronizer<T> {
 	public int updateListenerCode();

Modified: trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/AbstractDataModelArea.java
===================================================================
--- trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/AbstractDataModelArea.java	2011-03-07 11:33:16 UTC (rev 1235)
+++ trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/AbstractDataModelArea.java	2011-03-07 19:18:57 UTC (rev 1236)
@@ -8,6 +8,8 @@
 import org.cishell.utility.datastructure.datamodel.exception.UniqueNameException;
 import org.cishell.utility.datastructure.datamodel.field.DataModelField;
 
+/** See AbstractGUIDataModel.
+ */
 public abstract class AbstractDataModelArea<
 		BaseGUIComponentType, GUIContainerComponentType extends BaseGUIComponentType>
 		implements DataModelArea {

Modified: trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelArea.java
===================================================================
--- trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelArea.java	2011-03-07 11:33:16 UTC (rev 1235)
+++ trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelArea.java	2011-03-07 19:18:57 UTC (rev 1236)
@@ -7,8 +7,7 @@
 import org.cishell.utility.datastructure.datamodel.field.DataModelField;
 import org.cishell.utility.datastructure.datamodel.field.DataModelFieldContainer;
 
-/**
- * DataModelArea corresponds to a physical area tied to a DataModel GUI.
+/** DataModelArea corresponds to a physical area tied to a DataModel GUI.
  * DataModelAreas can contain other DataModelAreas, as well as DataModelFields.
  */
 public interface DataModelArea extends DataModelAreaContainer, DataModelFieldContainer {

Modified: trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelAreaContainer.java
===================================================================
--- trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelAreaContainer.java	2011-03-07 11:33:16 UTC (rev 1235)
+++ trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/area/DataModelAreaContainer.java	2011-03-07 19:18:57 UTC (rev 1236)
@@ -5,7 +5,10 @@
 import org.cishell.utility.datastructure.datamodel.exception.ModelStructureException;
 import org.cishell.utility.datastructure.datamodel.exception.UniqueNameException;
 
-// TODO: addToContainer type stuff
+/** A DataModelAreaContainer is anything that contains DataModelAreas. For example, DataModel
+ * and DataModelArea itself both can contain (other) DataModelAreas.
+ * TODO: addToContainer type stuff.
+ */
 public interface DataModelAreaContainer {
 	public Collection<String> getAreaNames();
 	public Collection<DataModelArea> getAreas();
@@ -22,7 +25,7 @@
 	public void addArea(DataModelArea area)
 			throws ClassCastException, ModelStructureException, UniqueNameException;
 	
-	//TODO: why is this returning boolean?
+	// TODO: Why is this returning boolean?
 	public boolean areaDisposed(String name);
 	public boolean areaDisposed(DataModelArea area);
 }
\ No newline at end of file

Modified: trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/field/DataModelFieldContainer.java
===================================================================
--- trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/field/DataModelFieldContainer.java	2011-03-07 11:33:16 UTC (rev 1235)
+++ trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/field/DataModelFieldContainer.java	2011-03-07 19:18:57 UTC (rev 1236)
@@ -4,6 +4,8 @@
 
 import org.cishell.utility.datastructure.datamodel.exception.UniqueNameException;
 
+/** A DataModelFieldContainer is anything that contains DataModelFields.
+ */
 public interface DataModelFieldContainer {
 	public Collection<String> getFieldNames();
 	public Collection<DataModelField<?>> getFields();

Modified: trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/group/DataModelGroup.java
===================================================================
--- trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/group/DataModelGroup.java	2011-03-07 11:33:16 UTC (rev 1235)
+++ trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/group/DataModelGroup.java	2011-03-07 19:18:57 UTC (rev 1236)
@@ -6,8 +6,7 @@
 import org.cishell.utility.datastructure.datamodel.field.DataModelField;
 import org.cishell.utility.datastructure.datamodel.field.DataModelFieldContainer;
 
-/**
- * Model groups are organizational structures for related DataModelFields.
+/** Model groups are organizational structures for related DataModelFields.
  * They are not tied to the physical structure of a GUI.
  * Anything that wishes to retrieve data from a DataModel can ask for ModelGroups.
  */

Modified: trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/gui/AbstractGUIDataModel.java
===================================================================
--- trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/gui/AbstractGUIDataModel.java	2011-03-07 11:33:16 UTC (rev 1235)
+++ trunk/core/org.cishell.utility.datastructure/src/org/cishell/utility/datastructure/datamodel/gui/AbstractGUIDataModel.java	2011-03-07 19:18:57 UTC (rev 1236)
@@ -12,8 +12,16 @@
 import org.cishell.utility.datastructure.datamodel.group.BasicModelGroup;
 import org.cishell.utility.datastructure.datamodel.group.DataModelGroup;
 
-/// TODO: Document this.
-/// TODO: Figure out a way to generically express styles for both widgets and areas.
+/** AbstractGUIDataModel is parameterized by BaseGUIComponentType and GUIContainerComponentType.
+ * It provides a default GUI-based implementation of DataModel that could be used in SWT, Swing,
+ * or any other Java GUI framework.
+ * BaseGUIComponentType should be the base type of the specific GUI framework widget (i.e.
+ * Control for SWT and Component for Swing.
+ * GUIContainerComponentType MUST extend BaseGUIComponentType, and in order for it to make any
+ * sense to this layer, it should be a GUI container type (i.e. Composite for SWT and
+ * Container for Swing).
+ * TODO: Figure out a way to generically express styles for both widgets and areas.
+ */
 public abstract class AbstractGUIDataModel<
 			BaseGUIComponentType, GUIContainerComponentType extends BaseGUIComponentType>
 		implements DataModel {


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.