eu.europeana.corelib.dereference.impl

Class Extractor

java.lang.Object

eu.europeana.corelib.dereference.impl.Extractor

public class Extractor
extends Object

Denormalization Utility. It retrieves the description of a reference URI according to the stored mappings

Author:

Yorgos.Mamakis@ kb.nl

Field Summary

Fields

Modifier and Type	Field and Description
protected VocabularyMongoServer	mongoServer
protected ControlledVocabularyImpl	vocabulary

Constructor Summary

Constructors

Constructor and Description
Extractor() Default constructor
Extractor(ControlledVocabularyImpl controlledVocabulary) Constructor for use with object injection
Extractor(ControlledVocabularyImpl controlledVocabulary, VocabularyMongoServer server) Constructor with the MongoDBServer for use without object Injection

Method Summary

Modifier and Type	Method and Description
ControlledVocabularyImpl	findVocabularyByName(String name, String uri) Find a Dereferencing vocabulary by name and URI
List<ControlledVocabularyImpl>	getControlledVocabularies() Retrieve all the stored controlled vocabularies
List<EdmMappedField>	getEdmLabel(String field) Retrieve the value of a field.
String	getMappedField(EdmLabel europeanaField) Get the mapped field value from an EdmLabel
boolean	isMapped(String field) Method to check if a field is mapped or not
HashMap<String,List<EdmMappedField>>	readSchema(String location) Read an XML file from a location (locally)
void	removeVocabulary(String vocabularyName) Remove a controlled vocabulary and its mappings
boolean	saveMapping(int iterations, String[] vocabularyRules, String vocabularyUrl) Save the mapping of a controlled vocabulary
void	setMappedField(String fieldToMap, EdmLabel europeanaField, String attribute) Map a field to an EdmLabel.
void	setMongoServer(VocabularyMongoServer server) Set a MongoServer
void	setVocabulary(ControlledVocabularyImpl vocabulary) Set active Vocabulary

Methods inherited from class java.lang.Object

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

Field Detail

mongoServer

protected VocabularyMongoServer mongoServer

vocabulary

protected ControlledVocabularyImpl vocabulary

Constructor Detail

Extractor

public Extractor(ControlledVocabularyImpl controlledVocabulary)

Constructor for use with object injection

Parameters:

controlledVocabulary - - The vocabulary to use

Extractor

public Extractor()

Default constructor

Extractor

public Extractor(ControlledVocabularyImpl controlledVocabulary,
                 VocabularyMongoServer server)

Constructor with the MongoDBServer for use without object Injection

Parameters:

controlledvocabulary - - The vocabulary to use

server - - The server to connect to

Method Detail

getControlledVocabularies

public List<ControlledVocabularyImpl> getControlledVocabularies()

Retrieve all the stored controlled vocabularies

Returns:

A list with all the stored controlled vocabularies

getEdmLabel

public List<EdmMappedField> getEdmLabel(String field)

Retrieve the value of a field. The value retrieved is part of the EdmLabel enumeration

Parameters:

field - The field to check

Returns:

The EdmLabel the field has been mapped to

setMappedField

public void setMappedField(String fieldToMap,
                           EdmLabel europeanaField,
                           String attribute)

Map a field to an EdmLabel. Short for Map mappings = new HashMap(); mappings.put(field,edmLabel); vocabulary.setElements(mappings);

Parameters:

fieldToMap -

europeanaField -

getMappedField

public String getMappedField(EdmLabel europeanaField)

Get the mapped field value from an EdmLabel

Parameters:

europeanaField - - the EdmLabel field string representation

Returns:

isMapped

public boolean isMapped(String field)

Method to check if a field is mapped or not

Parameters:

field - - The string representation of the field

Returns:

true if it is mapped, false otherwise

readSchema

public HashMap<String,List<EdmMappedField>> readSchema(String location)

Read an XML file from a location (locally)

Parameters:

location - The file path of the XML file

Returns:

an empty HashMap with keys being the Controlled Vocabulary fields and empty values

removeVocabulary

public void removeVocabulary(String vocabularyName)

Remove a controlled vocabulary and its mappings

Parameters:

vocabularyName -

saveMapping

public boolean saveMapping(int iterations,
                           String[] vocabularyRules,
                           String vocabularyUrl)

Save the mapping of a controlled vocabulary

findVocabularyByName

public ControlledVocabularyImpl findVocabularyByName(String name,
                                                     String uri)

Find a Dereferencing vocabulary by name and URI

Parameters:

name -

uri -

Returns:

setMongoServer

public void setMongoServer(VocabularyMongoServer server)

Set a MongoServer

Parameters:

server - The server to use

setVocabulary

public void setVocabulary(ControlledVocabularyImpl vocabulary)

Set active Vocabulary

Parameters:

vocabulary - The vocabulary currently being used