Package nl.knaw.dans.lib.dataverse

Class MetadataBlocksApi

java.lang.Object

nl.knaw.dans.lib.dataverse.MetadataBlocksApi

public class MetadataBlocksApi
extends Object

Metadata blocks API end-points.

See Also:

• Dataverse documentation

Field Summary

Fields

Modifier and Type	Field	Description
protected final nl.knaw.dans.lib.dataverse.HttpClientWrapper	httpClientWrapper
protected static final String	MDKEY_PARAM_NAME_PREFIX

Method Summary

Modifier and Type	Method	Description
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<MetadataBlockDefinition>	getMetadataBlock(int id)	Retrieves metadata block information by its integer ID.
DataverseHttpResponse<MetadataBlockDefinition>	getMetadataBlock(long id)	Retrieves metadata block information by its long ID.
DataverseHttpResponse<MetadataBlockDefinition>	getMetadataBlock(String identifier)	Retrieves metadata block information by its identifier (name or ID).
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
DataverseHttpResponse<List<MetadataBlockDefinition>>	listMetadataBlocks()	Retrieves a list of all metadata blocks.
DataverseHttpResponse<List<MetadataBlockDefinition>>	listMetadataBlocks(boolean onlyDisplayedOnCreate)	Retrieves a list of all metadata blocks with an option to filter only those displayed on create.
DataverseHttpResponse<List<MetadataBlockDefinition>>	listMetadataBlocks(boolean onlyDisplayedOnCreate, boolean returnDatasetFieldTypes)	Retrieves a list of all metadata blocks with options to filter only those displayed on create and to return dataset field types.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

MDKEY_PARAM_NAME_PREFIX

protected static final String MDKEY_PARAM_NAME_PREFIX

See Also:

• Constant Field Values

httpClientWrapper

protected final nl.knaw.dans.lib.dataverse.HttpClientWrapper httpClientWrapper

Method Details

listMetadataBlocks

public DataverseHttpResponse<List<MetadataBlockDefinition>> listMetadataBlocks()
                                                                        throws IOException,
DataverseException

Retrieves a list of all metadata blocks.

Returns:

a list of metadata blocks

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

listMetadataBlocks

public DataverseHttpResponse<List<MetadataBlockDefinition>> listMetadataBlocks(boolean onlyDisplayedOnCreate)
                                                                        throws IOException,
DataverseException

Retrieves a list of all metadata blocks with an option to filter only those displayed on create.

Parameters:

onlyDisplayedOnCreate - whether to return only metadata blocks displayed on create

Returns:

a list of metadata blocks

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

listMetadataBlocks

public DataverseHttpResponse<List<MetadataBlockDefinition>> listMetadataBlocks(boolean onlyDisplayedOnCreate,
 boolean returnDatasetFieldTypes)
                                                                        throws IOException,
DataverseException

Retrieves a list of all metadata blocks with options to filter only those displayed on create and to return dataset field types.

Parameters:

onlyDisplayedOnCreate - whether to return only metadata blocks displayed on create

returnDatasetFieldTypes - whether to include dataset field types

Returns:

a list of metadata blocks

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

getMetadataBlock

public DataverseHttpResponse<MetadataBlockDefinition> getMetadataBlock(String identifier)
                                                                throws IOException,
DataverseException

Retrieves metadata block information by its identifier (name or ID).

Parameters:

identifier - the metadata block identifier (name or ID)

Returns:

the metadata block

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

getMetadataBlock

public DataverseHttpResponse<MetadataBlockDefinition> getMetadataBlock(int id)
                                                                throws IOException,
DataverseException

Retrieves metadata block information by its integer ID.

Parameters:

id - the metadata block ID

Returns:

the metadata block

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

getMetadataBlock

public DataverseHttpResponse<MetadataBlockDefinition> getMetadataBlock(long id)
                                                                throws IOException,
DataverseException

Retrieves metadata block information by its long ID.

Parameters:

id - the metadata block ID

Returns:

the metadata block

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

toString

public String toString()

Overrides:

toString in class Object

buildPath

protected Path buildPath(Path base,
 String... components)

getQueryParamsFromMetadataKeys

protected Map<String,List<String>> getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)