Author: ruschein
Date: 2011-02-10 16:26:59 -0800 (Thu, 10 Feb 2011)
New Revision: 24094
Added:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableCellTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableColumnTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableCellTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableColumnTaskFactory.java
Log:
Foundation for tasks that operate on individual table cells or columns.
Added:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableCellTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableCellTask.java
(rev 0)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableCellTask.java
2011-02-11 00:26:59 UTC (rev 24094)
@@ -0,0 +1,52 @@
+/*
+ Copyright (c) 2010, The Cytoscape Consortium (www.cytoscape.org)
+
+ This library is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published
+ by the Free Software Foundation; either version 2.1 of the License, or
+ any later version.
+
+ This library is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF
+ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. The software and
+ documentation provided hereunder is on an "as is" basis, and the
+ Institute for Systems Biology and the Whitehead Institute
+ have no obligations to provide maintenance, support,
+ updates, enhancements or modifications. In no event shall the
+ Institute for Systems Biology and the Whitehead Institute
+ be liable to any party for direct, indirect, special,
+ incidental or consequential damages, including lost profits, arising
+ out of the use of this software and its documentation, even if the
+ Institute for Systems Biology and the Whitehead Institute
+ have been advised of the possibility of such damage. See
+ the GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with this library; if not, write to the Free Software Foundation,
+ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+*/
+package org.cytoscape.task.table;
+
+
+import org.cytoscape.model.CyColumn;
+import org.cytoscape.work.AbstractTask;
+
+
+/** A base class for Tasks that need to operate on a single CyTable cell. */
+public abstract class AbstractTableCellTask extends AbstractTask {
+ private final CyColumn column;
+ private final Object primaryKeyValue;
+
+ /** Initialises a Task that needs to operate on a CyTable cell entry.
+ * @param column a non-null CyColumn
+ * @param primaryKeyValue a non-null primary key value
+ */
+ public AbstractTableCellTask(final CyColumn column, final Object
primaryKeyValue) {
+ if (column == null)
+ throw new NullPointerException("\"column\" parameter
must *never* be null!");
+ this.column = column;
+ if (primaryKeyValue == null)
+ throw new NullPointerException("\"primaryKeyValue\"
parameter must *never* be null!");
+ this.primaryKeyValue = primaryKeyValue;
+ }
+}
\ No newline at end of file
Added:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableColumnTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableColumnTask.java
(rev 0)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/AbstractTableColumnTask.java
2011-02-11 00:26:59 UTC (rev 24094)
@@ -0,0 +1,47 @@
+/*
+ Copyright (c) 2010, The Cytoscape Consortium (www.cytoscape.org)
+
+ This library is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published
+ by the Free Software Foundation; either version 2.1 of the License, or
+ any later version.
+
+ This library is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF
+ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. The software and
+ documentation provided hereunder is on an "as is" basis, and the
+ Institute for Systems Biology and the Whitehead Institute
+ have no obligations to provide maintenance, support,
+ updates, enhancements or modifications. In no event shall the
+ Institute for Systems Biology and the Whitehead Institute
+ be liable to any party for direct, indirect, special,
+ incidental or consequential damages, including lost profits, arising
+ out of the use of this software and its documentation, even if the
+ Institute for Systems Biology and the Whitehead Institute
+ have been advised of the possibility of such damage. See
+ the GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with this library; if not, write to the Free Software Foundation,
+ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+*/
+package org.cytoscape.task.table;
+
+
+import org.cytoscape.model.CyColumn;
+import org.cytoscape.work.AbstractTask;
+
+
+/** A base class for Tasks that need to operate on an entire CyTable column. */
+public abstract class AbstractTableColumnTask extends AbstractTask {
+ private final CyColumn column;
+
+ /** Initialises a Task that needs to operate on a CyTable column.
+ * @param column a non-null CyColumn
+ */
+ public AbstractTableColumnTask(final CyColumn column) {
+ if (column == null)
+ throw new NullPointerException("\"column\" parameter
must *never* be null!");
+ this.column = column;
+ }
+}
\ No newline at end of file
Copied:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableCellTaskFactory.java
(from rev 24091,
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/DataTableTaskFactory.java)
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableCellTaskFactory.java
(rev 0)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableCellTaskFactory.java
2011-02-11 00:26:59 UTC (rev 24094)
@@ -0,0 +1,46 @@
+/*
+ Copyright (c) 2010, The Cytoscape Consortium (www.cytoscape.org)
+
+ This library is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published
+ by the Free Software Foundation; either version 2.1 of the License, or
+ any later version.
+
+ This library is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF
+ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. The software and
+ documentation provided hereunder is on an "as is" basis, and the
+ Institute for Systems Biology and the Whitehead Institute
+ have no obligations to provide maintenance, support,
+ updates, enhancements or modifications. In no event shall the
+ Institute for Systems Biology and the Whitehead Institute
+ be liable to any party for direct, indirect, special,
+ incidental or consequential damages, including lost profits, arising
+ out of the use of this software and its documentation, even if the
+ Institute for Systems Biology and the Whitehead Institute
+ have been advised of the possibility of such damage. See
+ the GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with this library; if not, write to the Free Software Foundation,
+ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+*/
+package org.cytoscape.task.table;
+
+
+import org.cytoscape.work.TaskFactory;
+import org.cytoscape.model.CyColumn;
+
+
+/**
+ * The assumption is that setColumnAndPrimaryKey() will be called before
getTask() and that the Task
+ * in question operates on the specified table entry identified by the column
and primary key value.'
+ */
+public interface TableCellTaskFactory extends TaskFactory {
+ /** Used to provision this factory with a {@param CyColumn} and a
primary key that will be
+ * used to create tasks.
+ * @param column a non-null CyColumn
+ * @param primaryKeyValue a non-null primary key value
+ */
+ public void setColumnAndPrimaryKey(final CyColumn column, final Object
primaryKeyValue);
+}
Copied:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableColumnTaskFactory.java
(from rev 24091,
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/DataTableTaskFactory.java)
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableColumnTaskFactory.java
(rev 0)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/table/TableColumnTaskFactory.java
2011-02-11 00:26:59 UTC (rev 24094)
@@ -0,0 +1,44 @@
+/*
+ Copyright (c) 2010, The Cytoscape Consortium (www.cytoscape.org)
+
+ This library is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published
+ by the Free Software Foundation; either version 2.1 of the License, or
+ any later version.
+
+ This library is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF
+ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. The software and
+ documentation provided hereunder is on an "as is" basis, and the
+ Institute for Systems Biology and the Whitehead Institute
+ have no obligations to provide maintenance, support,
+ updates, enhancements or modifications. In no event shall the
+ Institute for Systems Biology and the Whitehead Institute
+ be liable to any party for direct, indirect, special,
+ incidental or consequential damages, including lost profits, arising
+ out of the use of this software and its documentation, even if the
+ Institute for Systems Biology and the Whitehead Institute
+ have been advised of the possibility of such damage. See
+ the GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with this library; if not, write to the Free Software Foundation,
+ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+*/
+package org.cytoscape.task.table;
+
+
+import org.cytoscape.work.TaskFactory;
+import org.cytoscape.model.CyColumn;
+
+
+/**
+ * The assumption is that setColumn() will be called before getTask() and that
the Task in question
+ * operates on the specified CyColumn.
+ */
+public interface TableColumnTaskFactory extends TaskFactory {
+ /** Used to provision this factory with a {@param CyColumn} that will
be used to create tasks.
+ * @param column a non-null CyColumn
+ */
+ public void setColumn(final CyColumn column);
+}
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
