| <!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> *******************************************************************************<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Copyright (c) 2011, 2016 Diamond Light Source Ltd.<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> * Contributors:<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * Peter Chang - initial API and implementation and/or initial documentation<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>package org.eclipse.january.metadata;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import java.io.Serializable;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import java.util.Collection;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import java.util.Map;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import org.eclipse.january.MetadataException;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.eclipse.january.io.IDataAnalysisObject;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>/**<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * This interface describes the minimal metadata information that should be <a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * associated with a Dataset or DataHolder. It is intended that<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * this interface will be implemented in an object that will then be <a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * associated with a DataHolder or dataset using setMetadata(IMetadata).<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <p><a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * All returned collections and maps are <b>unmodifiable</b>.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public interface IMetadata extends IDataAnalysisObject, MetadataType, Serializable {<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> /**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Update this when there are any serious changes to API<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> static final long serialVersionUID = 8640458661665962384L;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Initialize metadata<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @param metadata<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> public void initialize(Map<String, ? extends Serializable> metadata);<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @return the path to the original file, or null if there was not a file.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> public String getFilePath();<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Returns a collection of dataset names or null if not implemented<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @return collection<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public Collection<String> getDataNames();<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Can be implemented to return sizes of datasets<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * (size can be null if it is not known)<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @return map of sizes<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public Map<String, Integer> getDataSizes();<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> * Can be implemented to return shapes of dataset<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * (shape can be null if it is not known)<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @return map of shapes<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> public Map<String, int[]> getDataShapes();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Returns string value or null if not implemented<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @param key<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return value<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @throws MetadataException<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public Serializable getMetaValue(String key) throws MetadataException;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Returns a collection of metadata names<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @return collection<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @throws MetadataException<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public Collection<String> getMetaNames() throws MetadataException;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * May be implemented to provide custom metadata in the form of a collection of serializable objects<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @return collection<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> public Collection<Serializable> getUserObjects();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Copy of metadata<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @return deep copy<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> @Override<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public IMetadata clone();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public void setFilePath(String filename);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> /**<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * Add name and shape of a dataset to metadata<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * <a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param name<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param shape (can be null or zero-length)<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * (NOTE method should be public, people can define loaders outside this<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * package like the DESY FIO loader for instance.)<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public void addDataInfo(String name, int... shape);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> public void addNames(Collection<String> names);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Set metadata map<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param metadata<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public void setMetadata(Map<String, ? extends Serializable> metadata);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span>}<a name="line.119"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
