Author: mkirby
Date: 2011-11-07 16:57:58 -0800 (Mon, 07 Nov 2011)
New Revision: 27425
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/DataCategory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReaderManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReader.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReaderManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReader.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReaderManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReader.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReaderManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/InputStreamTaskFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReader.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReaderManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriter.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterManager.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterManager.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/BasicCyFileFilter.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -15,9 +15,10 @@
import org.slf4j.LoggerFactory;
/**
- * This is meant to be an basic implementation of CyFileFilter that can either
be
+ * This is meant to be an basic implementation of {@link CyFileFilter} that
can either be
* used directly or extended to provide different acceptance criteria. Only
the
- * accepts() methods may be overridden.
+ * accepts() methods may be overridden.
+ * @CyAPI.Final.Class #ASKMIKE Should be final or static?
*/
public class BasicCyFileFilter implements CyFileFilter {
@@ -25,7 +26,7 @@
private final Set<String> contentTypes;
private final String description;
private final StreamUtil streamUtil;
- /** Type of data that this filter applys to. */
+ /** Type of data that this filter applies to. */
protected final DataCategory category;
private static final Logger logger =
LoggerFactory.getLogger(BasicCyFileFilter.class);
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilter.java
===================================================================
--- core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilter.java
2011-11-08 00:41:15 UTC (rev 27424)
+++ core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilter.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -8,6 +8,7 @@
* An interface that captures the metadata description of a file type
* so that files of the specified type can be handled correctly by the
* application and the user interface.
+ * @CyAPI.Spi.Interface
*/
public interface CyFileFilter {
@@ -38,7 +39,7 @@
Set<String> getExtensions();
/**
- * The MIME content types suppored by this filter.
+ * The MIME content types supported by this filter.
* @return A set of strings the describe the different MIME types
supported by this filter.
*/
Set<String> getContentTypes();
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/CyFileFilterProvider.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -4,6 +4,7 @@
/**
* An interface extended by various reader and writer factories.
* It provides basic information about the types of supported files.
+ * @CyAPI.Spi.Interface
*/
public interface CyFileFilterProvider {
/**
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/DataCategory.java
===================================================================
--- core3/api/trunk/io-api/src/main/java/org/cytoscape/io/DataCategory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++ core3/api/trunk/io-api/src/main/java/org/cytoscape/io/DataCategory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -2,6 +2,7 @@
/**
* An enum that captures the types of data the IO package can read and write.
+ * @CyAPI.Enum.Class
*/
public enum DataCategory {
/**
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReader.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -14,6 +14,7 @@
* processed by associated reader manager objects that distinguish
* InputStreamTaskFactories based on the DataCategory associated with the
* {@link org.cytoscape.io.CyFileFilter}.
+ * @CyAPI.Spi.Interface
*/
public interface CyNetworkReader extends Task {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReaderManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReaderManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyNetworkReaderManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -37,6 +37,7 @@
* processes specified input to determine the appropriate factory to
* use and then returns an instance of the correct {@link
org.cytoscape.io.read.CyNetworkReader}
* for the input.
+ * @CyAPI.Api.Interface
*/
public interface CyNetworkReaderManager {
/**
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReader.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReader.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReader.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -17,6 +17,7 @@
* by associated reader manager objects that distinguish
* InputStreamTaskFactories based on the DataCategory associated with
* the {@link org.cytoscape.io.CyFileFilter}.
+ * @CyAPI.Spi.Interface
*/
public interface CyPropertyReader extends Task {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReaderManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReaderManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyPropertyReaderManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -8,6 +8,7 @@
* processes specified input to determine the appropriate factory to
* use and then returns an instance of the correct {@link
org.cytoscape.io.read.CyPropertyReader}
* for the input.
+ * @CyAPI.Api.Interface
*/
public interface CyPropertyReaderManager {
/**
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReader.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReader.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReader.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -14,11 +14,12 @@
* by associated reader manager objects that distinguish
* InputStreamTaskFactories based on the {@link org.cytoscape.io.DataCategory}
associated with
* the {@link org.cytoscape.io.CyFileFilter}.
+ * @CyAPI.Spi.Interface
*/
public interface CySessionReader extends Task {
/**
- * return a {@link org.cytoscape.session.CySession} object
+ * Returns a {@link org.cytoscape.session.CySession} object
* @return A {@link org.cytoscape.session.CySession} object.
*/
CySession getCySession();
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReaderManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReaderManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CySessionReaderManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -8,6 +8,7 @@
* processes specified input to determine the appropriate factory to
* use and then returns an instance of the correct {@link
org.cytoscape.io.read.CySessionReader}
* for the input.
+ * @CyAPI.Api.Interface
*/
public interface CySessionReaderManager {
/**
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReader.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReader.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReader.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -11,6 +11,7 @@
* by associated reader manager objects that distinguish
* InputStreamTaskFactories based on the {@link org.cytoscape.io.DataCategory}
associated with
* the {@link org.cytoscape.io.CyFileFilter}.
+ * @CyAPI.Spi.Interface
*/
public interface CyTableReader extends Task{
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReaderManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReaderManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/CyTableReaderManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -37,6 +37,7 @@
* processes specified input to determine the appropriate factory to
* use and then returns an instance of the correct {@link
org.cytoscape.io.read.CyTableReader}
* for the input.
+ * @CyAPI.Api.Interface
*/
public interface CyTableReaderManager {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/InputStreamTaskFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/InputStreamTaskFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/InputStreamTaskFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -8,6 +8,7 @@
/**
* A super interface that allows the input stream to be set for reader
* task factories.
+ * @CyAPI.Spi.Interface
*/
public interface InputStreamTaskFactory extends TaskFactory,
CyFileFilterProvider {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReader.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReader.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReader.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -13,11 +13,13 @@
* by associated reader manager objects that distinguish
* InputStreamTaskFactories based on the {@link org.cytoscape.io.DataCategory}
associated with
* the {@link org.cytoscape.io.CyFileFilter}.
+ * @CyAPI.Spi.Interface
*/
public interface VizmapReader extends Task {
/**
- * @return A list of {@link org.cytoscape.view.vizmap.VisualStyle}
objects
+ * Returns a list of {@link org.cytoscape.view.vizmap.VisualStyle}
objects.
+ * @return A list of {@link org.cytoscape.view.vizmap.VisualStyle}
objects.
*/
Set<VisualStyle> getVisualStyles();
}
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReaderManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReaderManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/read/VizmapReaderManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -35,6 +35,7 @@
* processes specified input to determine the appropriate factory to
* use and then returns an instance of the correct {@link
org.cytoscape.io.read.VizmapReader}
* for the input.
+ * @CyAPI.Api.Interface
*/
public interface VizmapReaderManager {
/**
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/RecentlyOpenedTracker.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -7,13 +7,14 @@
/**
* Manages list of recently opened files.
* Currently, this is used for tracking recent sessions.
- *
+ * @CyAPI.Api.Interface
*/
public interface RecentlyOpenedTracker {
/**
- * @return the last addition or null if there are no URLs
+ * Returns the last addition or null if there are no URLs.
+ * @return the last addition or null if there are no URLs.
*/
URL getMostRecentlyOpenedURL();
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
===================================================================
--- core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
2011-11-08 00:41:15 UTC (rev 27424)
+++ core3/api/trunk/io-api/src/main/java/org/cytoscape/io/util/StreamUtil.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -8,6 +8,7 @@
/**
* A stateless utility class that provides special handling to support
* InputStreams and URLConnections over the network.
+ * @CyAPI.Api.Interface
*/
public interface StreamUtil {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/AbstractCyWriter.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -22,6 +22,7 @@
* is meant to be extended for specific file types such that the appropriate
* {@link org.cytoscape.io.write.CyWriter} can be identified.
* @param <T> Generic type that extends CyWriterManager.
+ * @CyAPI.Abstract.Class
*/
public abstract class AbstractCyWriter<T extends CyWriterManager> extends
AbstractTask
implements CyWriter
@@ -66,6 +67,7 @@
protected final T writerManager;
/**
+ * Constructor.
* @param writerManager The CyWriterManager to be used to determine
which
* {@link org.cytoscape.io.write.CyWriter} to be used to write the file
chosen by the user.
*/
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -5,6 +5,7 @@
/**
* A specialization of {@link CyWriterFactory} that allows a
* {@link CyNetworkView} to be specified and written.
+ * @CyAPI.Spi.Interface
*/
public interface CyNetworkViewWriterFactory extends CyWriterFactory {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyNetworkViewWriterManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -42,10 +42,13 @@
/**
* A {@link org.cytoscape.io.write.CyWriterManager} specific to writing
* {@link org.cytoscape.view.model.CyNetworkView} objects.
+ * @CyAPI.Api.Interface
*/
public interface CyNetworkViewWriterManager extends CyWriterManager {
/**
+ * Returns the {@link org.cytoscape.io.write.CyWriter} Task that will
attempt to write the specified view to the
+ * specified file of the specified file type.
* @param view The {@link org.cytoscape.view.model.CyNetworkView} to be
written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param file The file to be written.
@@ -56,6 +59,8 @@
CyWriter getWriter(CyNetworkView view, CyFileFilter filter, File file)
throws Exception;
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified view to the
+ * specified output steam of the specified file type.
* @param view The {@link org.cytoscape.view.model.CyNetworkView} to be
written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param os The output steam to be written.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -3,7 +3,8 @@
/**
* A specialization of {@link CyWriterFactory} that allows a property Object to
- * be specified and written. See CyProperty for details on the type of Object.
+ * be specified and written. See {@link org.cytoscape.property.CyProperty} for
details on the type of Object.
+ * @CyAPI.Spi.Interface
*/
public interface CyPropertyWriterFactory extends CyWriterFactory {
@@ -12,7 +13,7 @@
* generated by this factory. This method must be called
* prior to calling the getWriter() method.
* @param property The property object to be written. In general
- * this object should be of types described in CyProperty.
+ * this object should be of types described in {@link
org.cytoscape.property.CyProperty}.
*/
void setProperty(Object property);
}
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyPropertyWriterManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -37,15 +37,18 @@
/**
* A {@link CyWriterManager} specific to writing property objects. See
- * CyProperty for information on types of object expected.
+ * {@link org.cytoscape.property.CyProperty} for information on types of
object expected.
+ * @CyAPI.Api.Interface
*/
public interface CyPropertyWriterManager extends CyWriterManager {
/** Returns the <code>CyFileFilter</code>s known to this
<code>CyWriter</code> manager.
- * @return the set of known file filters
+ * @return the set of known file filters.
*/
List<CyFileFilter> getAvailableWriterFilters();
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified property
+ * object to the specified file of the specified file type.
* @param property The property object to be written.
* @param filter The {@link CyFileFilter} that defines the type of file
to be written.
* @param file The file to be written.
@@ -56,6 +59,8 @@
CyWriter getWriter(Object property, CyFileFilter filter, File file)
throws Exception;
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified property
+ * object to the specified output stream of the specified file type.
* @param property The property object to be written.
* @param filter The {@link CyFileFilter} that defines the type of file
to be written.
* @param os The output stream to be written.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriter.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriter.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriter.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -11,6 +11,7 @@
/**
* A utility Task implementation that writes a {@link
org.cytoscape.session.CySession} to a file.
+ * @CyAPI.Final.Class
*/
public final class CySessionWriter extends AbstractTask implements CyWriter {
private final CySession session;
@@ -18,6 +19,7 @@
private File outputFile;
/**
+ * Constructs this CySessionWriter.
* @param writerMgr The {@link
org.cytoscape.io.write.CySessionWriterManager} contains single expected
* {@link org.cytoscape.io.write.CySessionWriterFactory} to use to
write the file.
* @param session The {@link org.cytoscape.session.CySession} to be
written out.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -6,6 +6,7 @@
/**
* A specialization of {@link CyWriterFactory} that allows a {@link
org.cytoscape.session.CySession} to
* be specified and written.
+ * @CyAPI.Spi.Interface
*/
public interface CySessionWriterFactory extends CyWriterFactory {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CySessionWriterManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -41,10 +41,13 @@
/**
* A {@link CyWriterManager} specific to writing {@link
org.cytoscape.session.CySession} objects.
+ * @CyAPI.Api.Interface
*/
public interface CySessionWriterManager extends CyWriterManager {
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified session to the
+ * specified file of the specified file type.
* @param session The {@link org.cytoscape.session.CySession} to be
written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param file The file to be written.
@@ -55,6 +58,8 @@
CyWriter getWriter(CySession session, CyFileFilter filter, File file)
throws Exception;
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified session to the
+ * specified output stream of the specified file type.
* @param session The {@link org.cytoscape.session.CySession} to be
written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param os The output stream to be written.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -5,6 +5,7 @@
/**
* A specialization of {@link CyWriterFactory} that allows a {@link
org.cytoscape.model.CyTable} to
* be specified and written.
+ * @CyAPI.Spi.Interface
*/
public interface CyTableWriterFactory extends CyWriterFactory {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyTableWriterManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -41,10 +41,13 @@
/**
* A {@link CyWriterManager} specific to writing {@link
org.cytoscape.model.CyTable} objects.
+ * @CyAPI.Api.Interface
*/
public interface CyTableWriterManager extends CyWriterManager {
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified table to the
+ * specified file of the specified file type.
* @param table The {@link org.cytoscape.model.CyTable} to be written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param file The file to be written.
@@ -55,6 +58,8 @@
CyWriter getWriter(CyTable table, CyFileFilter filter, File file)
throws Exception;
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified table to the
+ * specified output stream of the specified file type.
* @param table The {@link org.cytoscape.model.CyTable} to be written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param os The output stream to be written.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriter.java
===================================================================
--- core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriter.java
2011-11-08 00:41:15 UTC (rev 27424)
+++ core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriter.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -7,6 +7,7 @@
/**
* A marker interface used to indicate that data will be written
* to a specified output stream.
+ * @CyAPI.Spi.Interface
*/
public interface CyWriter extends Task {
}
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -9,6 +9,7 @@
* for generating a Task to write the actual output. Instantiations
* of CyWriterFactories are meant to be singleton objects registered
* as OSGi services.
+ * @CyAPI.Spi.Interface
*/
public interface CyWriterFactory extends CyFileFilterProvider {
@@ -21,6 +22,8 @@
void setOutputStream(OutputStream os);
/**
+ * Returns a {@link CyWriter} Task suitable for writing to the specified
+ * output stream.
* @return A {@link CyWriter} Task suitable for writing to the specified
* output stream.
*/
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/CyWriterManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -43,10 +43,13 @@
* A CyWriterManager aggregates {@link CyWriterFactory} services for specific
DataCategories
* and provides a mechanism for choosing the {@link CyWriterFactory} given a
particular
* file type.
+ * @CyAPI.Api.Interface
*/
public interface CyWriterManager {
/**
+ * Returns a list of the available {@link CyFileFilter}s that define
the available
+ * output types.
* @return A list of the available {@link CyFileFilter}s that define
the available
* output types.
*/
@@ -54,6 +57,7 @@
/**
+ * Returns a {@link CyWriterFactory} for the appropriate filter.
* @param filter The filter used to determine the type of file written.
* @param os The {@link java.io.OutputStream} that will be written to
by the {@link CyWriter}
* generated by the {@link CyWriterFactory}.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -5,8 +5,9 @@
/**
* A specialization of {@link CyWriterFactory} that allows a View
- * rendererd by the specified {@link RenderingEngine} to
+ * rendered by the specified {@link RenderingEngine} to
* be specified and written.
+ * @CyAPI.Spi.Interface
*/
public interface PresentationWriterFactory extends CyWriterFactory {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/PresentationWriterManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -43,10 +43,13 @@
/**
* A {@link CyWriterManager} specific to writing View objects.
+ * @CyAPI.Api.Interface
*/
public interface PresentationWriterManager extends CyWriterManager {
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified view to the
+ * specified file of the specified file type.
* @param view The {@link View} to be written.
* @param re The {@link RenderingEngine} used to generate the image to
be written.
* @param filter The {@link CyFileFilter} that defines the type of file
to be written.
@@ -58,6 +61,8 @@
CyWriter getWriter(View<?> view, RenderingEngine<?> re, CyFileFilter
filter, File file) throws Exception;
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified view to the
+ * specified output stream of the specified file type.
* @param view The View to be written.
* @param re The {@link RenderingEngine} used to generate the image to
be written.
* @param filter The {@link CyFileFilter} that defines the type of file
to be written.
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterFactory.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -42,6 +42,7 @@
/**
* A specialization of {@link CyWriterFactory} that allows a {@link
org.cytoscape.view.vizmap.VisualStyle} to
* be specified and written.
+ * @CyAPI.Spi.Interface
*/
public interface VizmapWriterFactory extends CyWriterFactory {
Modified:
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterManager.java
===================================================================
---
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterManager.java
2011-11-08 00:41:15 UTC (rev 27424)
+++
core3/api/trunk/io-api/src/main/java/org/cytoscape/io/write/VizmapWriterManager.java
2011-11-08 00:57:58 UTC (rev 27425)
@@ -9,10 +9,13 @@
/**
* A {@link CyWriterManager} specific to writing {@link
org.cytoscape.view.vizmap.VisualStyle} objects.
+ * @CyAPI.Api.Interface
*/
public interface VizmapWriterManager extends CyWriterManager {
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified vizmap to the
+ * specified file of the specified file type.
* @param styles The list of {@link
org.cytoscape.view.vizmap.VisualStyle} objects to be written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param file The file to be written.
@@ -23,6 +26,8 @@
CyWriter getWriter(Set<VisualStyle> styles, CyFileFilter filter, File
file) throws Exception;
/**
+ * Returns the {@link CyWriter} Task that will attempt to write the
specified vizmap to the
+ * specified output stream of the specified file type.
* @param styles The list of {@link
org.cytoscape.view.vizmap.VisualStyle} objects to be written.
* @param filter The {@link org.cytoscape.io.CyFileFilter} that defines
the type of file to be written.
* @param os The output stream to be written.
--
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.
