Merge pull request #58 from jamesmudd/prepare-v0.3.2

Prepare v0.3.2

CHANGES.md

@@ -2,6 +2,12 @@
 
 Please note this project is still in pre-release development.
 
+## v0.3.2
+- Fix bug when fixed size string datasets contain strings of exactly that size.
+- Fix bug where >1D fixed size datasets could not be read
+- Add more JavaDoc
+- Minor refactoring
+
 ## v0.3.1
 - Add support for String datasets
 - Remove Dataset.getDataBuffer - Not all datasets can reasonably support accessing the backing buffer

jhdf/build.gradle

@@ -16,7 +16,7 @@ plugins {
 
 // Varibles
 group = 'io.jhdf'
-version = '0.3.1'
+version = '0.3.2'
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 

jhdf/src/main/java/io/jhdf/GroupImpl.java

@@ -17,10 +17,10 @@
 import io.jhdf.api.Group;
 import io.jhdf.api.Node;
 import io.jhdf.api.NodeType;
+import io.jhdf.btree.BTreeRecord;
 import io.jhdf.btree.BTreeV1;
 import io.jhdf.btree.BTreeV2;
-import io.jhdf.btree.record.BTreeRecord;
-import io.jhdf.btree.record.LinkNameForIndexedGroupRecord;
+import io.jhdf.btree.LinkNameForIndexedGroupRecord;
 import io.jhdf.dataset.DatasetLoader;
 import io.jhdf.exceptions.HdfException;
 import io.jhdf.exceptions.HdfInvalidPathException;

jhdf/src/main/java/io/jhdf/btree/record/BTreeRecord.java → jhdf/src/main/java/io/jhdf/btree/BTreeRecord.java

@@ -1,4 +1,4 @@
-package io.jhdf.btree.record;
+package io.jhdf.btree;
 
 import java.nio.ByteBuffer;
 

jhdf/src/main/java/io/jhdf/btree/BTreeV2.java

@@ -13,7 +13,6 @@
 
 import io.jhdf.Superblock;
 import io.jhdf.Utils;
-import io.jhdf.btree.record.BTreeRecord;
 import io.jhdf.exceptions.HdfException;
 
 public class BTreeV2 {

jhdf/src/main/java/io/jhdf/btree/record/LinkNameForIndexedGroupRecord.java → jhdf/src/main/java/io/jhdf/btree/LinkNameForIndexedGroupRecord.java

@@ -1,4 +1,4 @@
-package io.jhdf.btree.record;
+package io.jhdf.btree;
 
 import java.nio.ByteBuffer;
 

jhdf/src/main/java/io/jhdf/btree/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * B-tree classes
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.btree;

jhdf/src/main/java/io/jhdf/dataset/DatasetReader.java

@@ -260,7 +260,7 @@ private static void fillFixedLentghStringData(Object data, int[] dims, ByteBuffe
 		if (dims.length > 1) {
 			for (int i = 0; i < dims[0]; i++) {
 				Object newArray = Array.get(data, i);
-				fillData(newArray, stripLeadingIndex(dims), buffer);
+				fillFixedLentghStringData(newArray, stripLeadingIndex(dims), buffer, stringLength);
 			}
 		} else {
 			for (int i = 0; i < dims[0]; i++) {

jhdf/src/main/java/io/jhdf/dataset/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Dataset classes. The implementations of {@link io.jhdf.api.Dataset} and
+ * helper classes.
+ * 
+ * These are the classes used when accessing HDF5 datasets.
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.dataset;

jhdf/src/main/java/io/jhdf/examples/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Examples for using the jHDF library. This package is not included in the
+ * library jars.
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.examples;

jhdf/src/main/java/io/jhdf/exceptions/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Exceptions thrown by the jHDF library.
+ * 
+ * All exceptions extend {@link io.jhdf.exceptions.HdfException} which is a
+ * {@link java.lang.RuntimeException} this is intended to make the library
+ * easier to use.
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.exceptions;

jhdf/src/main/java/io/jhdf/filter/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * Support for HDF5 filters used when accessing chunked datasets.
+ * 
+ * Filters can add useful features such as compression, or error detection.
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.filter;

jhdf/src/main/java/io/jhdf/links/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * Classes implementing {@link io.jhdf.api.Link}.
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.links;

jhdf/src/main/java/io/jhdf/object/datatype/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * Classes representing the data types of HDF5 datasets.
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.object.datatype;

jhdf/src/main/java/io/jhdf/object/message/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Classes representing the messages within HDF5 object headers.
+ * 
+ * This package should be considered internal the classes should not be directly
+ * accessed when using the library.
+ * 
+ * @author James Mudd
+ */
+package io.jhdf.object.message;

jhdf/src/test/java/io/jhdf/btree/record/LinkNameForIndexedGroupRecordTest.java → jhdf/src/test/java/io/jhdf/btree/LinkNameForIndexedGroupRecordTest.java

@@ -1,4 +1,4 @@
-package io.jhdf.btree.record;
+package io.jhdf.btree;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
@@ -9,6 +9,7 @@
 
 import org.junit.jupiter.api.Test;
 
+import io.jhdf.btree.LinkNameForIndexedGroupRecord;
 import io.jhdf.exceptions.HdfException;
 
 class LinkNameForIndexedGroupRecordTest {