+ * Currently, it is not clear whether all columns actually have the same number + * of rows, that is if all arrays have the same length. In the case of variable + * row, this will return the maximum row count, that is the length of the + * longest array/column. + * + * @return the number of rows + */ + abstract int getRowCount(); + + /** + * The type of the elements in the column. The column array will be an array of + * the given type. For primitive types, this function will return the TYPE class + * (such as {@link Double#TYPE}, while {@link #getColumnData(int) } will return + * a {@link ListNumber}. + * + * @param column the column index + * @return the type of this column + */ + abstract Class getColumnType(int column); + + /** + * The name of the given column. + * + * @param column the column index + * @return the name of the column + */ + abstract String getColumnName(int column); + + /** + * The data for the given column. + *
+ * The data is going to be a {@link List} in case of objects or a + * {@link ListNumber} in case of a numeric primitive. + * + * @param column the column index + * @return the data of the column + */ + abstract Object getColumnData(int column); + + /** + * Create a new VTable + * + * @param types the types of each column + * @param names the name of each column + * @param values the values of each column + * @return an immutable instance of the VTable + */ + public static VTable of(List> types, List names, List values) { + return new IVTable(types, names, values); + } +} diff --git a/epics-vtype/vtype/src/main/java/org/epics/vtype/VType.java b/epics-vtype/vtype/src/main/java/org/epics/vtype/VType.java index a4dc0569c..bc5c21fc5 100644 --- a/epics-vtype/vtype/src/main/java/org/epics/vtype/VType.java +++ b/epics-vtype/vtype/src/main/java/org/epics/vtype/VType.java @@ -1,188 +1,190 @@ -/** - * Copyright information and license terms for this software can be - * found in the file LICENSE.TXT included with the distribution. - */ -package org.epics.vtype; - -import java.util.Arrays; -import java.util.Collection; -import java.util.List; -import org.epics.util.array.CollectionNumbers; -import org.epics.util.array.ListNumber; - -/** - * Tag interface to mark all the members of the value classes. - * - * @author carcassi - */ -public abstract class VType { - - private static final Collection> TYPES = Arrays.>asList( - VDouble.class, - VFloat.class, - VULong.class, - VLong.class, - VUInt.class, - VInt.class, - VUShort.class, - VShort.class, - VUByte.class, - VByte.class, - VEnum.class, - VBoolean.class, - VString.class, - VDoubleArray.class, - VFloatArray.class, - VULongArray.class, - VLongArray.class, - VUIntArray.class, - VIntArray.class, - VUShortArray.class, - VShortArray.class, - VUByteArray.class, - VByteArray.class); - - /** - * Returns the type of the object by returning the class object of one - * of the VXxx interfaces. The getClass() methods returns the - * concrete implementation type, which is of little use. If no - * super-interface is found, Object.class is used. - * - * @param obj an object implementing a standard type - * @return the type is implementing - */ - public static Class typeOf(Object obj) { - if (obj == null) - return null; - - for (Class type : TYPES) { - if (type.isInstance(obj)) { - return type; - } - } - - return Object.class; - } - - /** - * As {@link #toVType(java.lang.Object)} but throws an exception - * if conversion not possible. - * - * @param javaObject the value to wrap - * @return the new VType value - */ - public static VType toVTypeChecked(Object javaObject) { - VType value = toVType(javaObject); - if (value == null) { - throw new IllegalArgumentException("Value " + value + " cannot be converted to VType."); - } - return value; - } - - /** - * As {@link #toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display)} but throws an exception - * if conversion not possible. - * - * @param javaObject the value to wrap - * @param alarm the alarm - * @param time the time - * @param display the display - * @return the new VType value - */ - public static VType toVTypeChecked(Object javaObject, Alarm alarm, Time time, Display display) { - VType value = toVType(javaObject, alarm, time, display); - if (value == null) { - throw new IllegalArgumentException("Value " + value + " cannot be converted to VType."); - } - return value; - } - - /** - * Converts a standard java type to VTypes. Returns null if no conversion - * is possible. Calls {@link #toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display) } - * with no alarm, time now and no display. - * - * @param javaObject the value to wrap - * @return the new VType value - */ - public static VType toVType(Object javaObject) { - return toVType(javaObject, Alarm.none(), Time.now(), Display.none()); - } - - /** - * Converts a standard java type to VTypes. Returns null if no conversion - * is possible. Calls {@link #toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display) } - * with the given alarm, time now and no display. - * - * @param javaObject the value to wrap - * @param alarm the alarm - * @return the new VType value - */ - public static VType toVType(Object javaObject, Alarm alarm) { - return toVType(javaObject, alarm, Time.now(), Display.none()); - } - - /** - * Converts a standard java type to VTypes. Returns null if no conversion - * is possible. - * - * Types are converted as follow: - * - * Boolean -> VBoolean - * Number -> corresponding VNumber - * String -> VString - * number array -> corresponding VNumberArray - * ListNumber -> corresponding VNumberArray - * List -> if all elements are String, VStringArray - * - * - * @param javaObject the value to wrap - * @param alarm the alarm - * @param time the time - * @param display the display - * @return the new VType value - */ - public static VType toVType(Object javaObject, Alarm alarm, Time time, Display display) { - if (javaObject instanceof Number) { - return VNumber.of((Number) javaObject, alarm, time, display); - } else if (javaObject instanceof String) { - return VString.of((String) javaObject, alarm, time); - } else if (javaObject instanceof Boolean) { - return VBoolean.of((Boolean) javaObject, alarm, time); - } else if (javaObject instanceof byte[] - || javaObject instanceof short[] - || javaObject instanceof int[] - || javaObject instanceof long[] - || javaObject instanceof float[] - || javaObject instanceof double[]) { - return VNumberArray.of(CollectionNumbers.toList(javaObject), alarm, time, display); - } else if (javaObject instanceof ListNumber) { - return VNumberArray.of((ListNumber) javaObject, alarm, time, display); - } else if (javaObject instanceof String[]) { - return null;//newVStringArray(Arrays.asList((String[]) javaObject), alarm, time); - } else if (javaObject instanceof List) { - boolean matches = true; - List list = (List) javaObject; - for (Object object : list) { - if (!(object instanceof String)) { - matches = false; - } - } - if (matches) { - @SuppressWarnings("unchecked") - List newList = (List) list; - return null;//newVStringArray(Collections.unmodifiableList(newList), alarm, time); - } else { - return null; - } - } else { - return null; - } - } - - static void argumentNotNull(String argName, Object value) { - if (value == null) { - throw new NullPointerException(argName + " can't be null"); - } - } -} +/** + * Copyright information and license terms for this software can be + * found in the file LICENSE.TXT included with the distribution. + */ +package org.epics.vtype; + +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import org.epics.util.array.CollectionNumbers; +import org.epics.util.array.ListNumber; + +/** + * Tag interface to mark all the members of the value classes. + * + * @author carcassi + */ +public abstract class VType { + + private static final Collection> TYPES = Arrays.>asList( + VDouble.class, + VFloat.class, + VULong.class, + VLong.class, + VUInt.class, + VInt.class, + VUShort.class, + VShort.class, + VUByte.class, + VByte.class, + VEnum.class, + VBoolean.class, + VString.class, + VDoubleArray.class, + VFloatArray.class, + VULongArray.class, + VLongArray.class, + VUIntArray.class, + VIntArray.class, + VUShortArray.class, + VShortArray.class, + VUByteArray.class, + VByteArray.class, + VImage.class, + VTable.class); + + /** + * Returns the type of the object by returning the class object of one + * of the VXxx interfaces. The getClass() methods returns the + * concrete implementation type, which is of little use. If no + * super-interface is found, Object.class is used. + * + * @param obj an object implementing a standard type + * @return the type is implementing + */ + public static Class typeOf(Object obj) { + if (obj == null) + return null; + + for (Class type : TYPES) { + if (type.isInstance(obj)) { + return type; + } + } + + return Object.class; + } + + /** + * As {@link #toVType(java.lang.Object)} but throws an exception + * if conversion not possible. + * + * @param javaObject the value to wrap + * @return the new VType value + */ + public static VType toVTypeChecked(Object javaObject) { + VType value = toVType(javaObject); + if (value == null) { + throw new IllegalArgumentException("Value " + value + " cannot be converted to VType."); + } + return value; + } + + /** + * As {@link #toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display)} but throws an exception + * if conversion not possible. + * + * @param javaObject the value to wrap + * @param alarm the alarm + * @param time the time + * @param display the display + * @return the new VType value + */ + public static VType toVTypeChecked(Object javaObject, Alarm alarm, Time time, Display display) { + VType value = toVType(javaObject, alarm, time, display); + if (value == null) { + throw new IllegalArgumentException("Value " + value + " cannot be converted to VType."); + } + return value; + } + + /** + * Converts a standard java type to VTypes. Returns null if no conversion + * is possible. Calls {@link #toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display) } + * with no alarm, time now and no display. + * + * @param javaObject the value to wrap + * @return the new VType value + */ + public static VType toVType(Object javaObject) { + return toVType(javaObject, Alarm.none(), Time.now(), Display.none()); + } + + /** + * Converts a standard java type to VTypes. Returns null if no conversion + * is possible. Calls {@link #toVType(java.lang.Object, org.epics.vtype.Alarm, org.epics.vtype.Time, org.epics.vtype.Display) } + * with the given alarm, time now and no display. + * + * @param javaObject the value to wrap + * @param alarm the alarm + * @return the new VType value + */ + public static VType toVType(Object javaObject, Alarm alarm) { + return toVType(javaObject, alarm, Time.now(), Display.none()); + } + + /** + * Converts a standard java type to VTypes. Returns null if no conversion + * is possible. + * + * Types are converted as follow: + * + * Boolean -> VBoolean + * Number -> corresponding VNumber + * String -> VString + * number array -> corresponding VNumberArray + * ListNumber -> corresponding VNumberArray + * List -> if all elements are String, VStringArray + * + * + * @param javaObject the value to wrap + * @param alarm the alarm + * @param time the time + * @param display the display + * @return the new VType value + */ + public static VType toVType(Object javaObject, Alarm alarm, Time time, Display display) { + if (javaObject instanceof Number) { + return VNumber.of((Number) javaObject, alarm, time, display); + } else if (javaObject instanceof String) { + return VString.of((String) javaObject, alarm, time); + } else if (javaObject instanceof Boolean) { + return VBoolean.of((Boolean) javaObject, alarm, time); + } else if (javaObject instanceof byte[] + || javaObject instanceof short[] + || javaObject instanceof int[] + || javaObject instanceof long[] + || javaObject instanceof float[] + || javaObject instanceof double[]) { + return VNumberArray.of(CollectionNumbers.toList(javaObject), alarm, time, display); + } else if (javaObject instanceof ListNumber) { + return VNumberArray.of((ListNumber) javaObject, alarm, time, display); + } else if (javaObject instanceof String[]) { + return null;//newVStringArray(Arrays.asList((String[]) javaObject), alarm, time); + } else if (javaObject instanceof List) { + boolean matches = true; + List list = (List) javaObject; + for (Object object : list) { + if (!(object instanceof String)) { + matches = false; + } + } + if (matches) { + @SuppressWarnings("unchecked") + List newList = (List) list; + return null;//newVStringArray(Collections.unmodifiableList(newList), alarm, time); + } else { + return null; + } + } else { + return null; + } + } + + static void argumentNotNull(String argName, Object value) { + if (value == null) { + throw new NullPointerException(argName + " can't be null"); + } + } +} diff --git a/epics-vtype/vtype/src/test/java/org/epics/vtype/VImageTest.java b/epics-vtype/vtype/src/test/java/org/epics/vtype/VImageTest.java new file mode 100644 index 000000000..5ced6de40 --- /dev/null +++ b/epics-vtype/vtype/src/test/java/org/epics/vtype/VImageTest.java @@ -0,0 +1,64 @@ +package org.epics.vtype; + +import static org.junit.Assert.assertEquals; + +import java.awt.image.BufferedImage; +import java.awt.image.DataBufferByte; +import java.io.File; +import java.io.IOException; + +import javax.imageio.ImageIO; + +import org.epics.util.array.ArrayByte; +import org.epics.util.array.ListNumber; +import org.junit.Test; + +public class VImageTest { + + /** + * A test for the creation of a {@link VImage} data structure using an example image + */ + @Test + public void of() { + BufferedImage img = null; + VImage vImage = null; + boolean done = false; + try { + img = ImageIO.read(VType.class.getResource("Tulips.jpg")); + vImage = VImage.of(img.getHeight(), img.getWidth(), + ArrayByte.of(((DataBufferByte) img.getRaster().getDataBuffer()).getData()), VImageDataType.pvByte, + VImageType.TYPE_3BYTE_BGR, + Alarm.none(), Time.now()); + BufferedImage vImg = toImage(vImage); + for (int x = 0; x < vImage.getWidth(); x++) { + for (int y = 0; y < vImage.getHeight(); y++) { + assertEquals(img.getRGB(x, y), vImg.getRGB(x, y)); + } + } + done = true; + } catch (IOException e) { + } finally { + if (!done) { + BufferedImage bf = toImage(vImage); + try { + ImageIO.write(bf, "png", new File("src/test/resources/org/diirt/vtype/Tuplips-failed.jpg")); + } catch (IOException e) { + } + } + } + } + + private static BufferedImage toImage(VImage vImage) { + if (vImage.getVImageType() == VImageType.TYPE_3BYTE_BGR) { + BufferedImage image = new BufferedImage(vImage.getWidth(), vImage.getHeight(), BufferedImage.TYPE_3BYTE_BGR); + ListNumber data = vImage.getData(); + for (int i = 0; i < data.size(); i++) { + ((DataBufferByte) image.getRaster().getDataBuffer()).getData()[i] = data.getByte(i); + } + return image; + } else { + throw new UnsupportedOperationException( + "No support for creating a BufferedImage from Image Type: " + vImage.getVImageType()); + } + } +} diff --git a/epics-vtype/vtype/src/test/resources/org/epics/vtype/Tulips.jpg b/epics-vtype/vtype/src/test/resources/org/epics/vtype/Tulips.jpg new file mode 100644 index 000000000..54c51eb6a Binary files /dev/null and b/epics-vtype/vtype/src/test/resources/org/epics/vtype/Tulips.jpg differ diff --git a/pom.xml b/pom.xml index 0ef054900..bdb5e5708 100644 --- a/pom.xml +++ b/pom.xml @@ -34,6 +34,9 @@ pvDatabaseJava epics-core epics-deploy + epics-util + epics-vtype + gpclient diff --git a/pvDataJava/pom.xml b/pvDataJava/pom.xml index 8b40bdc94..4f0f2118e 100644 --- a/pvDataJava/pom.xml +++ b/pvDataJava/pom.xml @@ -42,4 +42,17 @@ https://github.com/epics-base/pvDataJava https://github.com/epics-base/pvDataJava + + + ${project.groupId} + epics-util + 1.0.0-SNAPSHOT + + + org.hamcrest + hamcrest-all + 1.3 + test + + diff --git a/pvDataJava/src/org/epics/pvdata/copy/package.html b/pvDataJava/src/org/epics/pvdata/copy/package.html index ebb177af4..4399d065a 100644 --- a/pvDataJava/src/org/epics/pvdata/copy/package.html +++ b/pvDataJava/src/org/epics/pvdata/copy/package.html @@ -18,5 +18,7 @@ + +
- * Types are converted as follow: - *
+ * Types are converted as follow: + *