| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*-<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Copyright 2015, 2016 Diamond Light Source Ltd.<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * All rights reserved. This program and the accompanying materials<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * are made available under the terms of the Eclipse Public License v1.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * which accompanies this distribution, and is available at<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * http://www.eclipse.org/legal/epl-v10.html<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> */<a name="line.8"></a> |
| <span class="sourceLineNo">009</span><a name="line.9"></a> |
| <span class="sourceLineNo">010</span>package org.eclipse.january.dataset;<a name="line.10"></a> |
| <span class="sourceLineNo">011</span><a name="line.11"></a> |
| <span class="sourceLineNo">012</span>/**<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * This interface is intended for data sources that change shape dynamically.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * Examples:<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * 1. An image stream from a camera encoded which entire image, changes periodically.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * 2. An HDF5 dataset which entire shape changes as data is added.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * <a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>public interface IDynamicShape {<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span> /**<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * Denotes an unlimited dimension in maximum shape<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> */<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> public static final int UNLIMITED = -1;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> /**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * @return dataset associated with shape<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> public ILazyDataset getDataset();<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> /**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Change shape<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * @param newShape<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @throws IllegalArgumentException if new shape exceeds maximum shape or is of different rank<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * @throws UnsupportedOperationException if used on a view<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @return true if shape has changed<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> public boolean resize(int... newShape);<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @return maximum shape (can be null)<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public int[] getMaxShape();<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Set maximum shape<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param maxShape maximum shape<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> public void setMaxShape(int... maxShape);<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Starts a periodic checker to see if dataset has changed in some manner. If any potential changes<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * are detected after the period has finished then registered listeners are alerted.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * A period of 0 or less will stop any existing checker.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param milliseconds period between checks in milliseconds<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param checker can be null for default implementation of alerting listeners unconditionally<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public void startUpdateChecker(int milliseconds, IDatasetChangeChecker checker);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Force the shape to be re-read from file, if possible<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @return true if shape has changed<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public boolean refreshShape();<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Add a listener which will be fired when aspects of the data change for<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * instance shape or content.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param l<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public void addDataListener(IDataListener l);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> <a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Remove a listener which will be fired when aspects of the data change for<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * instance shape or content.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param l<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public void removeDataListener(IDataListener l);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Alert any registered listeners<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> public void fireDataListeners();<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Add a listener which will be fired when aspects of the meta data change for<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * instance origin of data<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param l<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> // TODO Add this when required.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> //public void addMetadataListener(IMetadataListener l);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> <a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Remove a listener which will be fired when aspects of the meta data change for<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * instance origin of data<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param l<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> // TODO Add this when required.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> //public void removeDataListener(IMetadataListener l);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span>}<a name="line.103"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
