diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index f44a1c01..00000000
Binary files a/.DS_Store and /dev/null differ
diff --git a/.project b/.project
index e7601bd3..28684245 100644
--- a/.project
+++ b/.project
@@ -1,6 +1,6 @@
- * This protected operation notifies the listeners of the JanuaryObject that its
- * state has changed.
+ * This protected operation notifies the listeners of the JanuaryObject that
+ * its state has changed.
*
+ *
* The new clone. *
*/ @@ -340,18 +340,27 @@ public boolean equals(Object otherObject) { castedOtherObject = (AbstractEntry) otherObject; // Check each member attribute retVal = (this.uniqueId == castedOtherObject.uniqueId) - && (this.objectName.equals(castedOtherObject.objectName)) - && (this.objectDescription.equals(castedOtherObject.objectDescription) - && (defaultValue != null ? this.defaultValue.equals(castedOtherObject.defaultValue) + && (this.objectName + .equals(castedOtherObject.objectName)) + && (this.objectDescription + .equals(castedOtherObject.objectDescription) + && (defaultValue != null + ? this.defaultValue.equals( + castedOtherObject.defaultValue) : castedOtherObject.defaultValue == null) - && (tag != null ? this.tag.equals(castedOtherObject.tag) + && (tag != null + ? this.tag.equals(castedOtherObject.tag) : castedOtherObject.tag == null) - && (comment != null ? this.comment.equals(castedOtherObject.comment) + && (comment != null + ? this.comment.equals( + castedOtherObject.comment) : castedOtherObject.comment == null) && (this.isReady == castedOtherObject.isReady) && (this.isModified == castedOtherObject.isModified) && (this.isRequired == castedOtherObject.isRequired) - && (contextId != null ? this.contextId.equals(castedOtherObject.contextId) + && (contextId != null + ? this.contextId.equals( + castedOtherObject.contextId) : castedOtherObject.contextId == null)); } } @@ -374,7 +383,8 @@ public int hashCode() { hash = 31 * hash + uniqueId; // If objectName is null, add 0, otherwise add String.hashcode() hash = 31 * hash + (null == objectName ? 0 : objectName.hashCode()); - hash = 31 * hash + (null == objectDescription ? 0 : objectDescription.hashCode()); + hash = 31 * hash + (null == objectDescription ? 0 + : objectDescription.hashCode()); hash = 31 * hash + (null == defaultValue ? 0 : defaultValue.hashCode()); hash = 31 * hash + (null == comment ? 0 : comment.hashCode()); hash = 31 * hash + (null == tag ? 0 : tag.hashCode()); @@ -436,15 +446,14 @@ public void unregister(IUpdateableListener listener) { /* * (non-Javadoc) * - * @see - * org.eclipse.ice.datastructures.entry.IEntry#setValue(java.lang.String) + * @see org.eclipse.january.form.IEntry#setValue(java.lang.String) */ @Override public boolean setValue(String newValue) { if (value != null && value.equals(newValue)) { return true; } - + if (newValue != null) { this.value = newValue; isModified = true; @@ -458,8 +467,7 @@ public boolean setValue(String newValue) { /* * (non-Javadoc) * - * @see - * org.eclipse.ice.datastructures.entry.IEntry#setValue(java.lang.String[]) + * @see org.eclipse.january.form.IEntry#setValue(java.lang.String[]) */ @Override public abstract boolean setValue(String... values); @@ -467,7 +475,7 @@ public boolean setValue(String newValue) { /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.entry.IEntry#getValue() + * @see org.eclipse.january.form.IEntry#getValue() */ @Override public String getValue() { @@ -477,7 +485,7 @@ public String getValue() { /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.entry.IEntry#getValue(int) + * @see org.eclipse.january.form.IEntry#getValue(int) */ @Override public String getValue(int index) { @@ -487,7 +495,7 @@ public String getValue(int index) { /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.entry.IEntry#getValues() + * @see org.eclipse.january.form.IEntry#getValues() */ @Override public abstract String[] getValues(); @@ -495,7 +503,7 @@ public String getValue(int index) { /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.entry.IEntry#getDefaultValue() + * @see org.eclipse.january.form.IEntry#getDefaultValue() */ @Override public String getDefaultValue() { @@ -505,9 +513,7 @@ public String getDefaultValue() { /* * (non-Javadoc) * - * @see - * org.eclipse.ice.datastructures.entry.IEntry#setDefaultValue(java.lang. - * String) + * @see org.eclipse.january.form.IEntry#setDefaultValue(java.lang.String) */ @Override public void setDefaultValue(String value) { @@ -520,7 +526,7 @@ public void setDefaultValue(String value) { /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.entry.IEntry#getAllowedValues() + * @see org.eclipse.january.form.IEntry#getAllowedValues() */ @Override public abstract List+ * @return + *
* The unique ID of the Item that the Form represents. *
*/ @@ -134,7 +135,8 @@ public void setItemID(int newItemID) { * the Form. * * - * @return+ * @return + *
* The list of Actions that can be performed for this Form when it * is processed or null if no such list was provided. *
@@ -169,7 +171,8 @@ public void setActionList(ArrayList+ * @return + *
* True if the Form is complete, valid and can be processed. *
*/ @@ -206,7 +209,8 @@ public void markReady(boolean ready) { ** The other Form to which this Form should be compared. *
- * @return+ * @return + *
* True if the Forms are equal, false otherwise. *
*/ @@ -273,7 +277,8 @@ public boolean equals(Object otherForm) { * This operation returns the hashcode value of the Form. * * - * @return+ * @return + *
* The hashcode of the Form. *
*/ @@ -308,7 +313,8 @@ public int hashCode() { * This operation provides a deep copy of the Form. * * - * @return+ * @return + *
* The deep-copy clone of this Form. *
*/ @@ -378,7 +384,9 @@ public void copy(Form otherForm) { /* * (non-Javadoc) - * @see org.eclipse.ice.datastructures.JanuaryObject.JanuaryObject#update(java.lang.String, java.lang.String) + * + * @see org.eclipse.january.form.JanuaryObject#update(java.lang.String, + * java.lang.String) */ @Override public void update(String updatedKey, String newValue) { @@ -416,8 +424,8 @@ public void addComponent(Component child) { notifyListeners(); } else { // Otherwise throw an error exception - throw new RuntimeException("Data components in Forms " - + " cannot be null."); + throw new RuntimeException( + "Data components in Forms " + " cannot be null."); } return; diff --git a/org.eclipse.january.form/src/org/eclipse/january/form/GeometryComponent.java b/org.eclipse.january.form/src/org/eclipse/january/form/GeometryComponent.java index 98c8b2c0..96f6c80d 100644 --- a/org.eclipse.january.form/src/org/eclipse/january/form/GeometryComponent.java +++ b/org.eclipse.january.form/src/org/eclipse/january/form/GeometryComponent.java @@ -54,8 +54,8 @@ public class GeometryComponent extends JanuaryObject /** *- * This operation overrides the JanuaryObject.setName() operation and provides - * an update notification in addition to setting the name. + * This operation overrides the JanuaryObject.setName() operation and + * provides an update notification in addition to setting the name. *
* * @param name @@ -76,8 +76,8 @@ public void setName(String name) { /** *- * This operation overrides the JanuaryObject.setId() operation and provides an - * update notification in addition to setting the id. + * This operation overrides the JanuaryObject.setId() operation and provides + * an update notification in addition to setting the id. *
* * @param id @@ -346,10 +346,10 @@ public void accept(IComponentVisitor visitor) { /* * (non-Javadoc) - * + * * @see - * org.eclipse.ice.datastructures.JanuaryObject.IUpdateableListener#update(org. - * eclipse.ice.datastructures.JanuaryObject.IUpdateable) + * org.eclipse.january.form.IUpdateableListener#update(org.eclipse.january. + * form.IUpdateable) */ @Override public void update(IUpdateable component) { diff --git a/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryJAXBClassProvider.java b/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryJAXBClassProvider.java index efb6470f..5dfd6af2 100644 --- a/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryJAXBClassProvider.java +++ b/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryJAXBClassProvider.java @@ -30,8 +30,7 @@ public class JanuaryJAXBClassProvider implements IJAXBClassProvider { /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.jaxbclassprovider.IJAXBClassProvider# - * getClasses() + * @see org.eclipse.january.form.IJAXBClassProvider#getClasses() */ @Override public List* Operations are defined for most of the attributes and capabilities of the * JanuaryObject class, but some work is required by subclasses. Subclasses must - * override clone() if they extend JanuaryObject by adding attributes or the deep - * copy will fail. They should provide a custom implementation of copy() that is - * specific to their own type to do a deep copy (i.e. copy(a:myType) instead of - * copy(a:JanuaryObject)) since JanuaryObject.copy() will only copy the attributes of - * JanuaryObjects. They must also override the loadFromXML() operation to copy the - * XML data properly from the XMLLoader (because January uses JAXB to bind XML to - * JanuaryObjects and its subclasses). + * override clone() if they extend JanuaryObject by adding attributes or the + * deep copy will fail. They should provide a custom implementation of copy() + * that is specific to their own type to do a deep copy (i.e. copy(a:myType) + * instead of copy(a:JanuaryObject)) since JanuaryObject.copy() will only copy + * the attributes of JanuaryObjects. They must also override the loadFromXML() + * operation to copy the XML data properly from the XMLLoader (because January + * uses JAXB to bind XML to JanuaryObjects and its subclasses). *
** JanuaryObjects implement IUpdateable. The base class manages registering, @@ -61,9 +60,9 @@ public class JanuaryObject implements IUpdateable { /** * The context for this object. It should be used as described on - * {@link org.eclipse.january.form.Identifiable}. It is not - * persisted to XML because it only matters during runtime. It's default - * value is "january-default." + * {@link org.eclipse.january.form.Identifiable}. It is not persisted to XML + * because it only matters during runtime. It's default value is + * "january-default." */ @XmlTransient protected String context = "january-default"; @@ -79,9 +78,9 @@ public class JanuaryObject implements IUpdateable { protected String objectName; /** - * The description of the JanuaryObject. This description should be different - * than the name of the JanuaryObject and should contain information that would - * be useful to a human user. + * The description of the JanuaryObject. This description should be + * different than the name of the JanuaryObject and should contain + * information that would be useful to a human user. */ protected String objectDescription; @@ -218,8 +217,8 @@ public void copy(JanuaryObject entity) { } /** - * This protected operation notifies the listeners of the JanuaryObject that its - * state has changed. + * This protected operation notifies the listeners of the JanuaryObject that + * its state has changed. */ protected void notifyListeners() { @@ -365,7 +364,7 @@ public void unregister(IUpdateableListener listener) { /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.JanuaryObject.Identifiable#getContext() + * @see org.eclipse.january.form.Identifiable#getContext() */ @Override public String getContext() { @@ -375,9 +374,7 @@ public String getContext() { /* * (non-Javadoc) * - * @see - * org.eclipse.ice.datastructures.JanuaryObject.Identifiable#setContext(java. - * lang.String) + * @see org.eclipse.january.form.Identifiable#setContext(java.lang.String) */ @Override public void setContext(String context) { diff --git a/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryResource.java b/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryResource.java index 981444cb..25189147 100644 --- a/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryResource.java +++ b/org.eclipse.january.form/src/org/eclipse/january/form/JanuaryResource.java @@ -28,8 +28,8 @@ /** *
- * The Resource class represents persistent data resources used by January and the - * other software packages with which it interacts. This includes files + * The Resource class represents persistent data resources used by January and + * the other software packages with which it interacts. This includes files * containing simulation input and output data, movies and plots, amongst * others. *
@@ -64,13 +64,13 @@ public class JanuaryResource extends JanuaryObject { * */ @XmlElementWrapper - @XmlAnyElement(lax=true) + @XmlAnyElement(lax = true) private ArrayList- * An attribute that determines if JanuaryResouce is a picture or not. Can be - * set multiple times. + * An attribute that determines if JanuaryResouce is a picture or not. Can + * be set multiple times. *
* */ @@ -136,12 +136,15 @@ public JanuaryResource(File resourceFile) throws IOException { } - /* - * (non-Javadoc) + /** + *+ * This operation returns the last modification date of the file. + *
* - * @see - * org.eclipse.ice.datastructures.resource.IResource#getLastModificationDate - * () + * @return + *+ * The date. + *
*/ public String getLastModificationDate() { @@ -158,20 +161,31 @@ public String getLastModificationDate() { return retVal; } - /* - * (non-Javadoc) + /** + *+ * This operations returns the contents of the Resource as an instance of + * File. + *
* - * @see org.eclipse.ice.datastructures.resource.IResource#getContents() + * @return + *+ * The file. + *
*/ public File getContents() { return file; } - /* - * (non-Javadoc) + /** + *+ * This operation returns the URI to the Resource. + *
* - * @see org.eclipse.ice.datastructures.resource.IResource#getPath() + * @return + *+ * The path as a URL. + *
*/ public URI getPath() { if (this.file != null) { @@ -180,11 +194,13 @@ public URI getPath() { return path; } - /* - * (non-Javadoc) + /** + *+ * This operation sets the path to the Resource and is an alternative to + * setContents(). It will reset the File handle if it is different. + *
* - * @see - * org.eclipse.ice.datastructures.resource.IResource#setPath(java.net.URI) + * @param path */ public void setPath(URI path) { @@ -202,22 +218,34 @@ public void setPath(URI path) { } - /* - * (non-Javadoc) + /** + *+ * This operation associates a set of Entries with the resource that + * describe specific properties. The list of Entries is returned by + * reference and is not a deep copy, i.e. - changing one will change it on + * the resource. + *
* - * @see org.eclipse.ice.datastructures.resource.IResource#getProperties() + * @return + *+ * The properties or null if there are no properties. + *
*/ public ArrayList+ * This operation returns the set of Entries that describe specific + * properties of the resource. The properties can be set multiple times. + *
* - * @see - * org.eclipse.ice.datastructures.resource.IResource#setProperties(java.util - * .ArrayList) + * @param props + *+ * The properties. + *
*/ public void setProperties(ArrayList+ * This operation returns true if the ICEResource is an image and false if + * not based upon the isPicture attribute. + *
* - * @see org.eclipse.ice.datastructures.resource.IResource#isPictureType() + * @return + *+ * True if this is a picture, false otherwise. + *
*/ public boolean isPictureType() { return this.isPicture; } - /* - * (non-Javadoc) + /** + *+ * An operation that sets the isPicture attribute on ICEResource. + *
* - * @see - * org.eclipse.ice.datastructures.resource.IResource#setPictureType(boolean) + * @param isPicture + *+ * Determines if ICEResource is a picture. + *
*/ @XmlTransient public void setPictureType(boolean isPicture) { @@ -250,12 +288,12 @@ public void setPictureType(boolean isPicture) { } - /* - * (non-Javadoc) + /** + * This operation performs a deep copy of the attributes of another + * ICEResource into the current ICEResource. * - * @see - * org.eclipse.ice.datastructures.resource.IResource#copy(org.eclipse.ice. - * datastructures.resource.JanuaryResource) + * @param otherResource + * The other ICEResource from which information should be copied. */ public void copy(JanuaryResource otherResource) { @@ -301,12 +339,12 @@ public Object clone() { /** * This operation is used to check equality between the JanuaryResource and - * another JanuaryResource. It returns true if the JanuaryResources are equal and - * false if they are not. + * another JanuaryResource. It returns true if the JanuaryResources are + * equal and false if they are not. * * @param otherJanuaryResource - * The other JanuaryResource to which this JanuaryResource should be - * compared. + * The other JanuaryResource to which this JanuaryResource should + * be compared. * @return True if the JanuaryResources are equal, false otherwise. */ @Override @@ -369,12 +407,19 @@ public int hashCode() { } - /* - * (non-Javadoc) + /** + *+ * This operation sets the File which the Resource represents. The default + * values of the name, id and description for this class are the filename, 1 + * and the absolute path, respectively. + *
* - * @see - * org.eclipse.ice.datastructures.resource.IResource#setContents(java.io. - * File) + * @param resourceFile + *+ * The file that the Resource should be created to represent. + *
+ * @throws IOException + * @throws NullPointerException */ @XmlTransient public void setContents(File resourceFile) diff --git a/org.eclipse.january.form/src/org/eclipse/january/form/ListComponent.java b/org.eclipse.january.form/src/org/eclipse/january/form/ListComponent.java index a80cb93a..fb3669dc 100644 --- a/org.eclipse.january.form/src/org/eclipse/january/form/ListComponent.java +++ b/org.eclipse.january.form/src/org/eclipse/january/form/ListComponent.java @@ -35,9 +35,9 @@ * Collections in a class that realizes January's additional requirements for * persistence, unique identification, and notifications. *- * It implements the Component to match up with the January requirements and extends - * the TransformedList from GlazedLists to provide the generic, observable list - * capabilities. + * It implements the Component to match up with the January requirements and + * extends the TransformedList from GlazedLists to provide the generic, + * observable list capabilities. *
** It can be configured to provide a handle to an IElementSource that will @@ -549,7 +549,7 @@ public void removeListEventListener( /* * (non-Javadoc) * - * @see org.eclipse.ice.datastructures.JanuaryObject.Identifiable#getContext() + * @see org.eclipse.january.form.Identifiable#getContext() */ @Override public String getContext() { @@ -559,9 +559,7 @@ public String getContext() { /* * (non-Javadoc) * - * @see - * org.eclipse.ice.datastructures.JanuaryObject.Identifiable#setContext(java. - * lang.String) + * @see org.eclipse.january.form.Identifiable#setContext(java.lang.String) */ @Override public void setContext(String context) { diff --git a/org.eclipse.january.form/src/org/eclipse/january/form/MasterDetailsComponent.java b/org.eclipse.january.form/src/org/eclipse/january/form/MasterDetailsComponent.java index e8ae27a0..71b74e53 100644 --- a/org.eclipse.january.form/src/org/eclipse/january/form/MasterDetailsComponent.java +++ b/org.eclipse.january.form/src/org/eclipse/january/form/MasterDetailsComponent.java @@ -56,9 +56,9 @@ * three ways: by the name, id or reference to the master itself. *
*- * The MasterDetailsComponent is an JanuaryObject and is both uniquely identifiable - * and persistent to either XML or SQL. It implements the Component interface - * and can be visited and observed. + * The MasterDetailsComponent is an JanuaryObject and is both uniquely + * identifiable and persistent to either XML or SQL. It implements the Component + * interface and can be visited and observed. *
** The MasterDetailsComponent can be configured with a "header component." The @@ -66,8 +66,8 @@ * master-details pairs globally. For example, in the January MultiLauncher the * header contains an Entry to determine whether or not the jobs should be * launched sequentially or in parallel. This header is retrieved and set by - * calling get/setGlobalsComponent and it is referred to interchangeably as - * "the header" or "the globals" component. + * calling get/setGlobalsComponent and it is referred to interchangeably as "the + * header" or "the globals" component. *
*
* It is possible to generate a unique value for a particular master by calling
@@ -208,8 +208,8 @@ public void setTemplates(ArrayList
* The id of the master whose details should be retrieved.
*
+ * @return
+ *
* The details block for the master with the specified id.
*
+ * @return + *
* The id of the new master instance. *
*/ @@ -371,7 +375,8 @@ public int addMaster() { ** The id of the master that should be deleted. *
- * @return+ * @return + *
* True if the master was deleted, false otherwise. *
*/ @@ -410,7 +415,8 @@ public boolean deleteMaster(int id) { ** The id of the master that should be retrieved. *
- * @return+ * @return + *
* The value of the instance of the master with the given id. *
*/ @@ -454,7 +460,8 @@ public String getMasterValue(int id) { ** The new value of the master. *
- * @return+ * @return + *
* True if setting the value was successful, false otherwise. *
*/ @@ -484,7 +491,8 @@ public boolean setMasterInstanceValue(int id, String value) { if (this.masterDetailsPairs.get(i).getMasterDetailsPairId() == id) { // Set the DataComponent // Get the DataComponent to copy - for (int j = 0; j < this.masterDetailsTemplateList.size(); j++) { + for (int j = 0; j < this.masterDetailsTemplateList + .size(); j++) { if (this.masterDetailsTemplateList.get(j).getMaster() .equals(value)) { // Clone another dataComponent @@ -527,7 +535,8 @@ public boolean setMasterInstanceValue(int id, String value) { * masters when setMasterInstanceValue() is called. * * - * @return+ * @return + *
* The list of values that may be assigned to masters. *
*/ @@ -560,7 +569,8 @@ public ArrayList+ * @return + *
* True if the MasterDetailsComponents are equal, false otherwise. *
*/ @@ -614,7 +624,8 @@ public boolean equals(Object otherMasterDetailsComponent) { * This operation returns the hashcode value of the MasterDetailsComponent. * * - * @return+ * @return + *
* The hashcode. *
*/ @@ -627,19 +638,13 @@ public int hashCode() { hash = 31 * hash + super.hashCode(); // Compute attributes - hash = 31 - * hash - + (null == this.allowedMasters ? 0 : this.allowedMasters - .hashCode()); + hash = 31 * hash + (null == this.allowedMasters ? 0 + : this.allowedMasters.hashCode()); hash = 31 * hash + (null == this.counter ? 0 : this.counter.hashCode()); - hash = 31 - * hash - + (null == this.masterDetailsPairs ? 0 - : this.masterDetailsPairs.hashCode()); - hash = 31 - * hash - + (null == this.masterDetailsTemplateList ? 0 - : this.masterDetailsTemplateList.hashCode()); + hash = 31 * hash + (null == this.masterDetailsPairs ? 0 + : this.masterDetailsPairs.hashCode()); + hash = 31 * hash + (null == this.masterDetailsTemplateList ? 0 + : this.masterDetailsTemplateList.hashCode()); hash = 31 * hash + (null == this.globals ? 0 : this.globals.hashCode()); return hash; @@ -671,17 +676,18 @@ public void copy(MasterDetailsComponent otherMasterDetailsComponent) { // Copy allowedMasters this.allowedMasters.clear(); - for (int i = 0; i < otherMasterDetailsComponent.allowedMasters.size(); i++) { - this.allowedMasters.add(otherMasterDetailsComponent.allowedMasters - .get(i)); + for (int i = 0; i < otherMasterDetailsComponent.allowedMasters + .size(); i++) { + this.allowedMasters + .add(otherMasterDetailsComponent.allowedMasters.get(i)); } // Copy MasterDetailsPairs this.masterDetailsPairs.clear(); for (int i = 0; i < otherMasterDetailsComponent.masterDetailsPairs .size(); i++) { - this.masterDetailsPairs - .add((MasterDetailsPair) otherMasterDetailsComponent.masterDetailsPairs + this.masterDetailsPairs.add( + (MasterDetailsPair) otherMasterDetailsComponent.masterDetailsPairs .get(i).clone()); } @@ -689,8 +695,8 @@ public void copy(MasterDetailsComponent otherMasterDetailsComponent) { this.masterDetailsTemplateList.clear(); for (int i = 0; i < otherMasterDetailsComponent.masterDetailsTemplateList .size(); i++) { - this.masterDetailsTemplateList - .add((MasterDetailsPair) otherMasterDetailsComponent.masterDetailsTemplateList + this.masterDetailsTemplateList.add( + (MasterDetailsPair) otherMasterDetailsComponent.masterDetailsTemplateList .get(i).clone()); } @@ -713,7 +719,8 @@ public void copy(MasterDetailsComponent otherMasterDetailsComponent) { * This operation provides a deep copy of the MasterDetailsComponent. * * - * @return+ * @return + *
* The deep-copy clone of this MasterDetailsComponent. *
*/ @@ -747,7 +754,8 @@ private void rectifyDetailsBlock(int id) { * Returns the number of MasterDetailsPairs in masterDetailsPairs list. * * - * @return+ * @return + *
* Number of masters. *
*/ @@ -761,7 +769,8 @@ public int numberOfMasters() { * been set. This should be reviewed by clients if it is not null. * * - * @return+ * @return + *
* A returned DataComponent globals value. *
*/ @@ -799,7 +808,8 @@ public void setGlobalsComponent(DataComponent globals) { ** List index. *
- * @return+ * @return + *
* A string value in masterDetailsPairs list. *
*/ @@ -825,7 +835,8 @@ public String getMasterAtIndex(int index) { ** The index in the list. *
- * @return+ * @return + *
* The returned DataComponent. *
*/ @@ -850,7 +861,8 @@ public DataComponent getDetailsAtIndex(int index) { ** The unique masterDetailsPairId. *
- * @return+ * @return + *
* The unique master value, equal to 'id + " " + value'. *
*/ @@ -884,7 +896,8 @@ public String getUniqueMasterValue(int id) { ** The index in the list. *
- * @return+ * @return + *
* The unique master value, equal to 'id + " " + value'. *
*/ @@ -910,7 +923,8 @@ public String getUniqueMasterValueAtIndex(int index) { ** The index to be deleted. *
- * @return+ * @return + *
* Status of deletion. *
*/ @@ -934,7 +948,8 @@ public boolean deleteMasterAtIndex(int index) { * If false, the buttons should be disabled. * * - * @return+ * @return + *
* The status *
*/ @@ -962,7 +977,9 @@ public void toggleAddRemoveButton(boolean toggle) { /* * (non-Javadoc) - * @see org.eclipse.ice.datastructures.JanuaryObject.JanuaryObject#update(java.lang.String, java.lang.String) + * + * @see org.eclipse.january.form.JanuaryObject#update(java.lang.String, + * java.lang.String) */ @Override public void update(String updatedKey, String newValue) { diff --git a/org.eclipse.january.form/src/org/eclipse/january/form/MatrixComponent.java b/org.eclipse.january.form/src/org/eclipse/january/form/MatrixComponent.java index 4c7abeb9..c9155d2b 100644 --- a/org.eclipse.january.form/src/org/eclipse/january/form/MatrixComponent.java +++ b/org.eclipse.january.form/src/org/eclipse/january/form/MatrixComponent.java @@ -107,7 +107,8 @@ public class MatrixComponent extends JanuaryObject implements Component { * Returns true if this is a MatrixComponent representing a square matrix. * * - * @return+ * @return + *
* A boolean for determining if a matrix is square or not. *
*/ @@ -126,7 +127,8 @@ public boolean isSquare() { * type is not undefined for this operation to work. * * - * @return+ * @return + *
* A value returned representing the row number that was added. *
*/ @@ -138,8 +140,10 @@ public int addRow() { } // Return if Continuous or Discrete and valueType not set - if ((this.valueType == AllowedValueType.Continuous && this.allowedValues == null) - || (this.valueType == AllowedValueType.Discrete && this.allowedValues == null)) { + if ((this.valueType == AllowedValueType.Continuous + && this.allowedValues == null) + || (this.valueType == AllowedValueType.Discrete + && this.allowedValues == null)) { return -1; } @@ -175,7 +179,8 @@ public int addRow() { * The allowed value type for MatrixComponent. * */ - public MatrixComponent(boolean isSquare, AllowedValueType allowedValueType) { + public MatrixComponent(boolean isSquare, + AllowedValueType allowedValueType) { this.isSquare = isSquare; this.valueType = allowedValueType; @@ -196,7 +201,8 @@ public MatrixComponent(boolean isSquare, AllowedValueType allowedValueType) { * work. * * - * @return+ * @return + *
* A number that represents the index of the row deleted. *
*/ @@ -212,7 +218,7 @@ public boolean deleteRow() { if (this.valueType == AllowedValueType.Continuous && this.allowedValues == null || this.valueType == AllowedValueType.Discrete - && this.allowedValues == null) { + && this.allowedValues == null) { return false; } @@ -259,7 +265,8 @@ public boolean deleteRow() { * This operation returns the number of rows that are stored in the matrix. * * - * @return+ * @return + *
* The number of rows. *
*/ @@ -274,7 +281,8 @@ public int numberOfRows() { * matrix. * * - * @return+ * @return + *
* The number of columns. *
*/ @@ -308,9 +316,10 @@ public void copy(MatrixComponent otherMatrixComponent) { this.allowedValues = otherMatrixComponent.allowedValues; } else { this.allowedValues = new ArrayList+ * @return + *
* A clone of the TableComponent. *
*/ @@ -361,13 +371,14 @@ public Object clone() { ** The TableComponent that should be checked for equality. *
- * @return+ * @return + *
* True if the TableComponents are equal, false if not *
*/ @Override public boolean equals(Object otherMatrixComponent) { - + boolean retVal = true; // Check if they are the same reference in memory if (this == otherMatrixComponent) { @@ -406,7 +417,8 @@ public boolean equals(Object otherMatrixComponent) { * This operation returns the hashcode value of the MatrixComponent. * * - * @return+ * @return + *
* The hashcode *
*/ @@ -465,7 +477,8 @@ public int hashCode() { * set if the type is not undefined for this operation to work. * * - * @return+ * @return + *
* A value returned representing the column number that was added. *
*/ @@ -477,8 +490,10 @@ public int addColumn() { } // Return if Continuous or Discrete and valueType not set - if ((this.valueType == AllowedValueType.Continuous && this.allowedValues == null) - || (this.valueType == AllowedValueType.Discrete && this.allowedValues == null)) { + if ((this.valueType == AllowedValueType.Continuous + && this.allowedValues == null) + || (this.valueType == AllowedValueType.Discrete + && this.allowedValues == null)) { return -1; } @@ -502,7 +517,8 @@ public int addColumn() { * for this operation to work. * * - * @return+ * @return + *
* A number that represents the index of the column deleted. *
*/ @@ -515,8 +531,10 @@ public boolean deleteColumn() { } // Return if Continuous or Discrete and valueType not set - if ((this.valueType == AllowedValueType.Continuous && this.allowedValues == null) - || (this.valueType == AllowedValueType.Discrete && this.allowedValues == null)) { + if ((this.valueType == AllowedValueType.Continuous + && this.allowedValues == null) + || (this.valueType == AllowedValueType.Discrete + && this.allowedValues == null)) { return false; } @@ -577,7 +595,8 @@ public boolean deleteColumn() { ** The value to be set. *
- * @return+ * @return + *
* Returns true if operation was successful. False otherwise. *
*/ @@ -601,8 +620,10 @@ public boolean setElementValue(int rowIndex, int colIndex, Double value) { // Return if allowedValueType is not set // Return if Continuous or Discrete and valueType not set - if ((this.valueType == AllowedValueType.Continuous && this.allowedValues == null) - || (this.valueType == AllowedValueType.Discrete && this.allowedValues == null)) { + if ((this.valueType == AllowedValueType.Continuous + && this.allowedValues == null) + || (this.valueType == AllowedValueType.Discrete + && this.allowedValues == null)) { return false; } @@ -639,7 +660,8 @@ public boolean setElementValue(int rowIndex, int colIndex, Double value) { ** The column index. *
- * @return+ * @return + *
* The value at rowIndex, colIndex. *
*/ @@ -657,8 +679,10 @@ public Double getElementValue(int rowIndex, int colIndex) { // Return if the valueType is not set correctly // Return if Continuous or Discrete and valueType not set - if ((this.valueType == AllowedValueType.Continuous && this.allowedValues == null) - || (this.valueType == AllowedValueType.Discrete && this.allowedValues == null)) { + if ((this.valueType == AllowedValueType.Continuous + && this.allowedValues == null) + || (this.valueType == AllowedValueType.Discrete + && this.allowedValues == null)) { return null; } @@ -694,7 +718,8 @@ public void setAllowedValues(ArrayList* The index of the row. *
- * @return+ * @return + *
* An arraylist of a row at index. *
*/ @@ -809,7 +835,8 @@ public ArrayList* The column index. *
- * @return+ * @return + *
* An arraylist of columns. *
*/ @@ -956,7 +983,8 @@ private void resizeSquareMatrix(boolean addOrRemove) { * Returns true if the matrix can be resized. False otherwise. * * - * @return+ * @return + *
* A boolean to determine resizable attribute. *
*/ @@ -989,7 +1017,8 @@ public void setResizable(boolean resizable) { * Returns the January's AllowedValueType. If this is not set, returns null. * * - * @return+ * @return + *
* An ArrayList of doubles. *
*/ @@ -1005,7 +1034,8 @@ public AllowedValueType getAllowedValueType() { * undefined or not set, returns null. * * - * @return+ * @return + *
* An AllowedValueType. *
*/ @@ -1027,7 +1057,9 @@ public ArrayList* When a Component is added to a TreeComposite (keep in mind Composites are @@ -300,7 +300,7 @@ public void setParent(TreeComposite pNode) { *
* * @return - *+ *
* The parent node. *
*/ @@ -314,7 +314,7 @@ public TreeComposite getParent() { * * * @return - *+ *
* The next child in the set of child TreeComposites or null if the * end of the set has been reached. *
@@ -417,7 +417,7 @@ && checkExemplars(cNode)) { * * * @return - *+ *
* The previous child in the set of child TreeComposites or null if * the iterator has returned to the beginning of the set. *
@@ -524,7 +524,7 @@ public void resetChildIterator() { * The index at which the desired child can be found. * * @return - *+ *
* The child or null if the index is out of bounds. *
*/ @@ -545,7 +545,7 @@ public TreeComposite getChildAtIndex(int index) { * * * @return - *+ *
* The next or "nearest right" sibling in the tree. *
*/ @@ -560,7 +560,7 @@ public TreeComposite getNextSibling() { * * * @return - *+ *
* The previous or "nearest left" sibling in the tree. *
*/ @@ -577,7 +577,7 @@ public TreeComposite getPreviousSibling() { * * * @return - *+ *
* The set of Components managed by the TreeComposite. *
*/ @@ -604,7 +604,7 @@ public int getNumberOfDataNodes() { * * * @return - *+ *
* The active data node or null if it has not been specified. *
*/ @@ -685,7 +685,7 @@ public void allowActiveDataNodes(boolean allow) { * compared. * * @return - *+ *
* True if the TreeComposites are equal, false otherwise. *
*/ @@ -731,7 +731,7 @@ public boolean equals(Object otherTreeComposite) { * * * @return - *+ *
* The hashcode. *
*/ @@ -899,7 +899,7 @@ public void copy(TreeComposite otherTreeComposite, boolean copyInPlace) { * * * @return - *+ *
* The deep-copy clone of this TreeComposite. *
*/ @@ -983,7 +983,7 @@ public void addChildExemplar(TreeComposite exemplar) { * * * @return - *+ *
* The set of exemplar child types ("set of exemplars"). *
*/ @@ -1001,7 +1001,7 @@ public ArrayList+ *
* True if the exemplars exist, false otherwise. *
*/ @@ -1016,7 +1016,7 @@ public boolean hasChildExemplars() { * * * @return - *+ *
* True if Active, false if not *
*/ @@ -1338,8 +1338,8 @@ public void visit(IReactorComponent component) { * (non-Javadoc) * * @see - * org.eclipse.ice.datastructures.componentVisitor.IComponentVisitor#visit - * (org.eclipse.ice.datastructures.form.TimeDataComponent) + * org.eclipse.january.form.IComponentVisitor#visit(org.eclipse.january.form + * .TimeDataComponent) */ @Override public void visit(TimeDataComponent component) { @@ -1413,12 +1413,26 @@ public void unregister(IUpdateableListener listener) { return; } + /* + * (non-Javadoc) + * + * @see + * org.eclipse.january.form.IComponentVisitor#visit(org.eclipse.january.form + * .emf.EMFComponent) + */ @Override public void visit(EMFComponent component) { // TODO Auto-generated method stub } + /* + * (non-Javadoc) + * + * @see + * org.eclipse.january.form.IComponentVisitor#visit(org.eclipse.january.form + * .ListComponent) + */ @Override public void visit(ListComponent component) { // TODO Auto-generated method stub diff --git a/org.eclipse.january.form/src/org/eclipse/january/form/VizResource.java b/org.eclipse.january.form/src/org/eclipse/january/form/VizResource.java index 7862c70a..db9b94f9 100644 --- a/org.eclipse.january.form/src/org/eclipse/january/form/VizResource.java +++ b/org.eclipse.january.form/src/org/eclipse/january/form/VizResource.java @@ -30,7 +30,7 @@ * */ @XmlRootElement(name = "VizResource") -public class VizResource extends JanuaryResource{ +public class VizResource extends JanuaryResource { /** * The set of files contained associated with this resource @@ -97,15 +97,20 @@ public VizResource(File resourceFile, ArrayList