54
54
* but leaves the implementation of the cell writing to specialized implementations.
55
55
*
56
56
* See {@link DiskCachedCellImgFactory} for a specialized example.
57
+ *
58
+ * @param <T> Element type of the images that can be created by this factory
57
59
*
58
60
* @author Tobias Pietzsch
59
61
* @author Carsten Haubold, KNIME GmbH, Konstanz, Germany
@@ -80,6 +82,15 @@ public AbstractReadWriteCachedCellImgFactory(final T type) {
80
82
/**
81
83
* Create a cached cell img with the provided settings. Much of the work is deferred to abstract methods that
82
84
* must be implemented for the specific writer-backend in specialized classes.
85
+ *
86
+ * @param dimensions Dimensions of the image that should be created
87
+ * @param cacheLoader Loader for already cached cells (optional)
88
+ * @param cellLoader Loader for Cells that are not cached yet (optional, cache will provide empty cells if this is null)
89
+ * @param type Instance of the element type of the image that should be created
90
+ * @param typeFactory A native type factory
91
+ * @param additionalOptions Cache options that extend this cache factory's options
92
+ * @param <A> Access Type
93
+ * @return A CachedCellImg with the given cache configuration
83
94
*/
84
95
protected <A extends ArrayDataAccess <A >> CachedCellImg <T , ? extends A > create (final long [] dimensions ,
85
96
final CacheLoader <Long , ? extends Cell <?>> cacheLoader ,
@@ -131,8 +142,14 @@ public AbstractReadWriteCachedCellImgFactory(final T type) {
131
142
}
132
143
133
144
/**
134
- * Derived classes should create an instance of the CachedCellImg type that they support.
145
+ * Derived classes should create an instance of the CachedCellImg type that they support, given the provided cache and grid
135
146
* E.g. a {@link DiskCachedCellImgFactory} would create and return a {@link DiskCachedCellImg}.
147
+ *
148
+ * @param grid The grid structure of the CellCache
149
+ * @param entitiesPerPixel
150
+ * @param cache The configured cache to use as backing for the image
151
+ * @param accessType
152
+ * @return A {@link CachedCellImg}
136
153
*/
137
154
protected abstract <A extends ArrayDataAccess <A >> CachedCellImg <T , ? extends A > createCachedCellImg (
138
155
final CellGrid grid ,
@@ -148,7 +165,7 @@ public AbstractReadWriteCachedCellImgFactory(final T type) {
148
165
* @param backingLoader the backing loader for cache cells
149
166
* @param type element type
150
167
* @param entitiesPerPixel
151
- * @return
168
+ * @return A {@link ReadWriteCellCache}
152
169
*/
153
170
protected abstract <A extends ArrayDataAccess <A >> ReadWriteCellCache <A > createCellCache (
154
171
final AbstractReadWriteCachedCellImgOptions options ,
0 commit comments