hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 10:04:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

DS-4107 Improve javadocs

Browse Source
This commit is contained in:
Chris Wilper
2019-02-07 06:12:04 -05:00
parent 60ea589296
commit 0609a6f0b7
6 changed files with 74 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
dspace-spring-rest/src/main/java/org/dspace/app/rest/converter/MetadataConverter.java
View File

@@ -29,6 +29,9 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;
/**
* Converter to translate between lists of domain {@link MetadataValue}s and {@link MetadataRest} representations.
*/
@Component
public class MetadataConverter implements Converter<List<MetadataValue>, MetadataRest> {
@@ -38,6 +41,12 @@ public class MetadataConverter implements Converter<List<MetadataValue>, Metadat
@Autowired
private MetadataValueConverter valueConverter;
/**
* Gets a rest representation of the given list of domain metadata values.
*
* @param metadataValueList the domain values.
* @return the rest representation.
*/
@Override
public MetadataRest convert(List<MetadataValue> metadataValueList) {
// Convert each value to a DTO while retaining place order in a map of key -> SortedSet
@@ -64,11 +73,11 @@ public class MetadataConverter implements Converter<List<MetadataValue>, Metadat
}
/**
* Completely replaces the metadata in the given dso.
* Sets a DSpace object's domain metadata values from a rest representation.
*
* @param context the context to use.
* @param dso the dso whose metadata should be updated.
* @param metadataRest the new metadata.
* @param dso the DSpace object.
* @param metadataRest the rest representation of the new metadata.
* @throws SQLException if a database error occurs.
* @throws AuthorizeException if an authorization error occurs.
*/

21
dspace-spring-rest/src/main/java/org/dspace/app/rest/converter/MetadataValueConverter.java
View File

@@ -12,17 +12,26 @@ import org.dspace.content.MetadataValue;
import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;
/**
* Converter to translate between domain {@link MetadataValue}s and {@link MetadataValueRest} representations.
*/
@Component
public class MetadataValueConverter implements Converter<MetadataValue, MetadataValueRest> {
/**
* Gets a rest representation of the given domain metadata value.
*
* @param metadataValue the domain value.
* @return the rest representation.
*/
@Override
public MetadataValueRest convert(MetadataValue model) {
public MetadataValueRest convert(MetadataValue metadataValue) {
MetadataValueRest metadataValueRest = new MetadataValueRest();
metadataValueRest.setValue(model.getValue());
metadataValueRest.setLanguage(model.getLanguage());
metadataValueRest.setAuthority(model.getAuthority());
metadataValueRest.setConfidence(model.getConfidence());
metadataValueRest.setPlace(model.getPlace());
metadataValueRest.setValue(metadataValue.getValue());
metadataValueRest.setLanguage(metadataValue.getLanguage());
metadataValueRest.setAuthority(metadataValue.getAuthority());
metadataValueRest.setConfidence(metadataValue.getConfidence());
metadataValueRest.setPlace(metadataValue.getPlace());
return metadataValueRest;
}
}

5
dspace-spring-rest/src/main/java/org/dspace/app/rest/model/DSpaceObjectRest.java
View File

@@ -51,6 +51,11 @@ public abstract class DSpaceObjectRest extends BaseObjectRest<String> {
this.handle = handle;
}
/**
* Gets the rest representation of all metadata of the DSpace object.
*
* @return the metadata.
*/
public MetadataRest getMetadata() {
return metadata;
}

14
dspace-spring-rest/src/main/java/org/dspace/app/rest/model/MetadataRest.java
View File

@@ -15,11 +15,19 @@ import java.util.TreeMap;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
/**
* Rest representation of a map of metadata keys to ordered lists of values.
*/
public class MetadataRest {
@JsonAnySetter
private SortedMap<String, List<MetadataValueRest>> map = new TreeMap();
/**
* Gets the map.
*
* @return the map of keys to ordered values.
*/
@JsonAnyGetter
public SortedMap<String, List<MetadataValueRest>> getMap() {
return map;
@@ -30,9 +38,9 @@ public class MetadataRest {
*
* @param key the key.
* @param values the values. The values will be ordered according to their {@code place} value, if
* nonnegative. Values that are negative (the default is -1) are assume to be non-explicitly
* set and will will be ordered at the end of the list, after the last value with an order,
* in the order they are passed to this method.
* nonnegative. Values that are negative (the default is -1) are assumed to be non-explicitly
* set and will will be ordered at the end of any explicitly ordered values, in the order
* they are passed to this method.
* @return this instance, to support chaining calls for easy initialization.
*/
public MetadataRest put(String key, MetadataValueRest... values) {

13
dspace-spring-rest/src/main/java/org/dspace/app/rest/model/MetadataValueRest.java
View File

@@ -7,7 +7,10 @@
*/
package org.dspace.app.rest.model;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.dspace.app.rest.converter.MetadataConverter;
/**
* An embeddable representation of the Metadata to use in with DSpace REST
@@ -25,6 +28,16 @@ public class MetadataValueRest {
int confidence;
/**
* The order of this metadata value with respect to others in the same DSO with the same key.
*
* In the REST representation, all values of the same key are given as a json array that expresses
* their relative order, so there is no need to expose the exact numeric value publicly. The numeric
* value is only used at this level to ensure the intended order is respected when converting to/from json.
*
* @see MetadataConverter#convert(List)
* @see MetadataRest#put(String, MetadataValueRest...)
*/
@JsonIgnore
int place = -1;

18
dspace-spring-rest/src/test/java/org/dspace/app/rest/matcher/MetadataMatcher.java
View File

@@ -13,14 +13,32 @@ import static org.hamcrest.Matchers.is;
import org.hamcrest.Matcher;
/**
* Utility class to provide convenient matchers for metadata.
*/
public class MetadataMatcher {
private MetadataMatcher() { }
/**
* Gets a matcher to ensure a given value is present among all values for a given metadata key.
*
* @param key the metadata key.
* @param value the value that must be present.
* @return the matcher.
*/
public static Matcher<? super Object> matchMetadata(String key, String value) {
return hasJsonPath("$.['" + key + "'][*].value", contains(value));
}
/**
* Gets a matcher to ensure a given value is present at a specific position in the list of values for a given key.
*
* @param key the metadata key.
* @param value the value that must be present.
* @param position the position it must be present at.
* @return the matcher.
*/
public static Matcher<? super Object> matchMetadata(String key, String value, int position) {
return hasJsonPath("$.['" + key + "'][" + position + "].value", is(value));
}