com.gooddata.md

Class MetadataService

java.lang.Object

com.gooddata.AbstractService

com.gooddata.md.MetadataService

public class MetadataService
extends AbstractService

Query, create and update project metadata - attributes, facts, metrics, reports,...

Nested Class Summary

Nested classes/interfaces inherited from class com.gooddata.AbstractService

AbstractService.OutputStreamResponseExtractor

Field Summary

Fields inherited from class com.gooddata.AbstractService

mapper, noopRequestCallback, restTemplate, WAIT_BEFORE_RETRY_IN_MILLIS

Constructor Summary

Constructors

Constructor and Description
MetadataService(org.springframework.web.client.RestTemplate restTemplate)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Obj> T	createObj(Project project, T obj) Create metadata object in given project
<T extends Queryable> Collection<Entry>	find(Project project, Class<T> cls, Restriction... restrictions) Find metadata by restrictions like identifier, title or summary.
<T extends Queryable> Collection<String>	findUris(Project project, Class<T> cls, Restriction... restrictions) Find metadata URIs by restrictions like identifier, title or summary.
<T extends Queryable> T	getObj(Project project, Class<T> cls, Restriction... restrictions) Get metadata object by restrictions like identifier, title or summary.
<T extends Obj> T	getObjById(Project project, String id, Class<T> cls) Get metadata object by id.
<T extends Obj> T	getObjByUri(String uri, Class<T> cls) Get metadata object by URI (format is /gdc/md/{PROJECT_ID}/obj/{OBJECT_ID})
<T extends Queryable> String	getObjUri(Project project, Class<T> cls, Restriction... restrictions) Get metadata object URI by restrictions like identifier, title or summary.

Methods inherited from class com.gooddata.AbstractService

extractData

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataService

public MetadataService(org.springframework.web.client.RestTemplate restTemplate)

Method Detail

createObj

public <T extends Obj> T createObj(Project project,
                          T obj)

Create metadata object in given project

Type Parameters:

T - type of the object to be created

Parameters:

project - project

obj - metadata object to be created

Returns:

new metadata object

Throws:

ObjCreateException - if creation failed

ObjNotFoundException - if new metadata object not found after creation

GoodDataRestException - if GoodData REST API returns unexpected status code when getting the new object

GoodDataException - if it encounters client-side HTTP errors when getting the new object

getObjByUri

public <T extends Obj> T getObjByUri(String uri,
                            Class<T> cls)

Get metadata object by URI (format is /gdc/md/{PROJECT_ID}/obj/{OBJECT_ID})

Type Parameters:

T - type of the object to be returned

Parameters:

uri - URI in format /gdc/md/{PROJECT_ID}/obj/{OBJECT_ID}

cls - class of the resulting object

Returns:

the metadata object

Throws:

ObjNotFoundException - if metadata object not found

GoodDataRestException - if GoodData REST API returns unexpected status code

GoodDataException - if it encounters client-side HTTP errors

getObjById

public <T extends Obj> T getObjById(Project project,
                           String id,
                           Class<T> cls)

Get metadata object by id.

Type Parameters:

T - type of the object to be returned

Parameters:

project - project where to search for the object

id - id of the object

cls - class of the resulting object

Returns:

the metadata object

Throws:

ObjNotFoundException - if metadata object not found

GoodDataRestException - if GoodData REST API returns unexpected status code

GoodDataException - if it encounters client-side HTTP errors

getObjUri

public <T extends Queryable> String getObjUri(Project project,
                                     Class<T> cls,
                                     Restriction... restrictions)

Get metadata object URI by restrictions like identifier, title or summary.

Type Parameters:

T - type of the object to be returned

Parameters:

project - project where to search for the object

cls - class of the resulting object

restrictions - query restrictions

Returns:

the URI of metadata object

Throws:

ObjNotFoundException - if metadata object not found

NonUniqueObjException - if more than one object corresponds to search restrictions

getObj

public <T extends Queryable> T getObj(Project project,
                             Class<T> cls,
                             Restriction... restrictions)

Get metadata object by restrictions like identifier, title or summary.

Type Parameters:

T - type of the object to be returned

Parameters:

project - project where to search for the object

cls - class of the resulting object

restrictions - query restrictions

Returns:

metadata object

Throws:

ObjNotFoundException - if metadata object not found

NonUniqueObjException - if more than one object corresponds to search restrictions

find

public <T extends Queryable> Collection<Entry> find(Project project,
                                           Class<T> cls,
                                           Restriction... restrictions)

Find metadata by restrictions like identifier, title or summary.

Type Parameters:

T - type of the metadata referenced in returned entries

Parameters:

project - project where to search for the metadata

cls - class of searched metadata

restrictions - query restrictions

Returns:

the collection of metadata entries

Throws:

GoodDataException - if unable to query metadata

findUris

public <T extends Queryable> Collection<String> findUris(Project project,
                                                Class<T> cls,
                                                Restriction... restrictions)

Find metadata URIs by restrictions like identifier, title or summary.

Type Parameters:

T - type of the metadata referenced by returned URIs

Parameters:

project - project where to search for the metadata

cls - class of searched metadata

restrictions - query restrictions

Returns:

the collection of metadata URIs

Throws:

GoodDataException - if unable to query metadata