de.gwdg.metadataqa.api.schema

Interface Schema

All Known Implementing Classes:

BaseSchema, EdmFullBeanLimitedSchema, EdmFullBeanSchema, EdmOaiPmhJsonSchema, EdmOaiPmhXmlSchema, EdmOaiPmLimitedJsonSchema, EdmSchema, MarcJsonSchema

public interface Schema

The representation of a metadata schema. It does not cover all the fine details of a schema such as an XML Schema, it concentrates only on those elements which take role in the measurement.

Author:

Péter Király

Method Summary

Modifier and Type	Method and Description
void	addExtractableField(String label, String jsonPath) Add a single field to the map of extractable fields.
List<Category>	getCategories()
List<JsonBranch>	getCollectionPaths() Return collection paths.
Map<String,String>	getExtractableFields() Get fields for which the values should be extracted from the records.
List<FieldGroup>	getFieldGroups() Field groups used in completeness sub-dimensions.
Format	getFormat()
List<String>	getNoLanguageFields() List of field which can be skipped in the language extraction.
JsonBranch	getPathByLabel(String label) Returns a path by its label.
List<JsonBranch>	getPaths() The list of fields to investigate in most of the measurements.
List<JsonBranch>	getRootChildrenPaths() Return the paths of root's direct children.
List<RuleChecker>	getRuleCheckers()
Map<String,String>	getSolrFields() Map of fields covered in TF-IDF extraction.
void	setExtractableFields(Map<String,String> extractableFields) Set the extractable fields.

Method Detail

getFormat

Format getFormat()

getCollectionPaths

List<JsonBranch> getCollectionPaths()

Return collection paths.

Returns:

List of collection paths

getRootChildrenPaths

List<JsonBranch> getRootChildrenPaths()

Return the paths of root's direct children.

Returns:

Paths.

getPaths

List<JsonBranch> getPaths()

The list of fields to investigate in most of the measurements.

Returns:

List of field representations

getPathByLabel

JsonBranch getPathByLabel(String label)

Returns a path by its label.

Parameters:

label - The label to look for.

Returns:

The branch.

getFieldGroups

List<FieldGroup> getFieldGroups()

Field groups used in completeness sub-dimensions. Groupped values are optional elements in a sub-dimension.

Returns:

List of groups

getNoLanguageFields

List<String> getNoLanguageFields()

List of field which can be skipped in the language extraction.

Returns:

List of skippable fields

getSolrFields

Map<String,String> getSolrFields()

Map of fields covered in TF-IDF extraction. The key should be qualified name, the value should be the Solr field name. For example: solrFields.put("Proxy/dc:title", "dc_title_txt");

Returns:

The map of fields

getExtractableFields

Map<String,String> getExtractableFields()

Get fields for which the values should be extracted from the records.

Returns:

The map of extractable fields. The key is the label of a field, the value is a JSON path expression.

setExtractableFields

void setExtractableFields(Map<String,String> extractableFields)

Set the extractable fields.

Parameters:

extractableFields - The extractable fields.

See Also:

getExtractableFields()

addExtractableField

void addExtractableField(String label,
                         String jsonPath)

Add a single field to the map of extractable fields.

Parameters:

label - The label of the field.

jsonPath - JSON path expression.

getCategories

List<Category> getCategories()

getRuleCheckers

List<RuleChecker> getRuleCheckers()