ControlledVocabulary (Europeana Core Library Dereferencing Toolkit 2.6.3 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

ControlledVocabularyImpl
```
public interface ControlledVocabulary
extends Serializable
```
Generic ControlledVocabulary interfaces. It exposes the necessary methods to create a controlled vocabulary from a File or URL, as well as generic methods to map and retrieve mapped fields.

Author:

Yorgos.Mamakis@ kb.nl

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Map<String,List<EdmMappedField>>`	`getElements()` Retrieve the original elements of the controlled vocabulary
`org.bson.types.ObjectId`	`getId()` MongoDB ID getter
`int`	`getIterations()`
`String`	`getLocation()` Get vocabulary location
`String`	`getName()` Get the ControlledVocabulary name (Unique)
`String`	`getReplaceUrl()` Getter for the replaceURL
`String[]`	`getRules()` URI-Based rules getter for a specific controlled vocabulary.
`String`	`getSuffix()` Retrieve the suffix of the controlled vocabulary
`String`	`getURI()` Retrieve the URI of the controlled vocabulary TODO: Check if needed
`void`	`setElements(Map<String,List<EdmMappedField>> elements)` Set the original elements of the controlled vocabulary
`void`	`setId(org.bson.types.ObjectId id)` MongoDB ID setter
`void`	`setIterations(int iterations)` Specify the depth of resources to retrieve from a given resource.
`void`	`setLocation(String location)` Set the Controlled Vocabulary location
`void`	`setName(String name)` Set the vocabulary name
`void`	`setReplaceUrl(String replaceUrl)` Specify the replaceURL if applicable e.g.
`void`	`setRules(String[] rules)` URI-Based rules setter for a specific controlled vocabulary.
`void`	`setSuffix(String suffix)` Set the suffix of the controlled vocabulary
`void`	`setURI(String URI)` Set the URI of the vocabulary TODO: check if needed

- Method Detail
  - getElements
```
Map<String,List<EdmMappedField>> getElements()
```
    Retrieve the original elements of the controlled vocabulary
    
    Returns:
    
    A list of the elements of the controlled vocabulary
  - getName
```
String getName()
```
    Get the ControlledVocabulary name (Unique)
    
    Returns:
    
    The controlled vocabulary name
  - setLocation
```
void setLocation(String location)
```
    Set the Controlled Vocabulary location
    
    Parameters:
    
    location - - The location to set
  - getLocation
```
String getLocation()
```
    Get vocabulary location
    
    Returns:
    
    The Controlled vocabulary
  - setName
```
void setName(String name)
```
    Set the vocabulary name
    
    Parameters:
    
    name - - the name of the vocabulary to set
  - setURI
```
void setURI(String URI)
```
    Set the URI of the vocabulary TODO: check if needed
    
    Parameters:
    
    URI - The URI to set
  - getURI
```
String getURI()
```
    Retrieve the URI of the controlled vocabulary TODO: Check if needed
    
    Returns:
    
    The URI of the controlled vocabulary
  - getSuffix
```
String getSuffix()
```
    Retrieve the suffix of the controlled vocabulary
    
    Returns:
    
    The suffix of the controlled vocabulary
  - setSuffix
```
void setSuffix(String suffix)
```
    Set the suffix of the controlled vocabulary
    
    Parameters:
    
    suffix - The suffix of the controlled vocabulary
  - setElements
```
void setElements(Map<String,List<EdmMappedField>> elements)
```
    Set the original elements of the controlled vocabulary
    
    Parameters:
    
    elements -
  - getId
```
org.bson.types.ObjectId getId()
```
    MongoDB ID getter
    
    Returns:
  - setId
```
void setId(org.bson.types.ObjectId id)
```
    MongoDB ID setter
    
    Parameters:
    
    id -
  - getRules
```
String[] getRules()
```
    URI-Based rules getter for a specific controlled vocabulary. E.g. in the MIMO controlled vocabularies there are people and objects mapped, however their mappings in EDM should be placed on a different contextual entities; namely edm:Agent and skos:Concept respectively. The URI-based rules considers the existence of a specific rule in the URI of the stored resource e.g. http://www.mimo-de.eu/InstrumentsKeywords/2308 the rule being InstrumentKeywords There might be more than one rules per mapping, while * wildcard is also allowed
    
    Returns:
  - setRules
```
void setRules(String[] rules)
```
    URI-Based rules setter for a specific controlled vocabulary. E.g. in the MIMO controlled vocabularies there are people and objects mapped, however their mappings in EDM should be placed on a different contextual entities; namely edm:Agent and skos:Concept respectively. The URI-based rules considers the existence of a specific rule in the URI of the stored resource e.g. http://www.mimo-de.eu/InstrumentsKeywords/2308 the rule being InstrumentKeywords There might be more than one rules per mapping, while * wildcard is also allowed
  - setIterations
```
void setIterations(int iterations)
```
    Specify the depth of resources to retrieve from a given resource. If for example a dbpedia entry refers to another dbpedia entry, and iterations>0 then the referred dbpedia entry, will also be fetched
    
    Parameters:
    
    iterations - The number of iterations
  - getIterations
```
int getIterations()
```
    Returns:
    
    The number of iterations to get
  - setReplaceUrl
```
void setReplaceUrl(String replaceUrl)
```
    Specify the replaceURL if applicable e.g. Geonames use as their name space www.geonames.org but their RDF is accessible using sws.geonames.org
    
    Parameters:
    
    replaceUrl - - The url that will replace the given uri in the search
  - getReplaceUrl
```
String getReplaceUrl()
```
    Getter for the replaceURL
    
    Returns:
    
    The String to be used to retrieve the stored record

Interface ControlledVocabulary

Method Summary

Method Detail

getElements

getName

setLocation

getLocation

setName

setURI

getURI

getSuffix

setSuffix

setElements

getId

setId

getRules

setRules

setIterations

getIterations

setReplaceUrl

getReplaceUrl