de.gwdg.metadataqa.api.schema

Class BaseSchema

java.lang.Object

de.gwdg.metadataqa.api.schema.BaseSchema

All Implemented Interfaces:

CsvAwareSchema, Schema

public class BaseSchema
extends Object
implements Schema, CsvAwareSchema

Constructor Summary

Constructors

Constructor and Description
BaseSchema()

Method Summary

Modifier and Type	Method and Description
void	addExtractableField(String label, String jsonPath) Add a single field to the map of extractable fields.
BaseSchema	addField(JsonBranch branch)
BaseSchema	addField(String fieldName)
BaseSchema	addFields(String... 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>	getHeader()
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.
BaseSchema	setFormat(Format format)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSchema

public BaseSchema()

Method Detail

addField

public BaseSchema addField(JsonBranch branch)

addField

public BaseSchema addField(String fieldName)

addFields

public BaseSchema addFields(String... fields)

setFormat

public BaseSchema setFormat(Format format)

getFormat

public Format getFormat()

Specified by:

getFormat in interface Schema

getCollectionPaths

public List<JsonBranch> getCollectionPaths()

Description copied from interface: Schema

Return collection paths.

Specified by:

getCollectionPaths in interface Schema

Returns:

List of collection paths

getRootChildrenPaths

public List<JsonBranch> getRootChildrenPaths()

Description copied from interface: Schema

Return the paths of root's direct children.

Specified by:

getRootChildrenPaths in interface Schema

Returns:

Paths.

getPaths

public List<JsonBranch> getPaths()

Description copied from interface: Schema

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

Specified by:

getPaths in interface Schema

Returns:

List of field representations

getPathByLabel

public JsonBranch getPathByLabel(String label)

Description copied from interface: Schema

Returns a path by its label.

Specified by:

getPathByLabel in interface Schema

Parameters:

label - The label to look for.

Returns:

The branch.

getFieldGroups

public List<FieldGroup> getFieldGroups()

Description copied from interface: Schema

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

Specified by:

getFieldGroups in interface Schema

Returns:

List of groups

getNoLanguageFields

public List<String> getNoLanguageFields()

Description copied from interface: Schema

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

Specified by:

getNoLanguageFields in interface Schema

Returns:

List of skippable fields

getSolrFields

public Map<String,String> getSolrFields()

Description copied from interface: Schema

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");

Specified by:

getSolrFields in interface Schema

Returns:

The map of fields

getExtractableFields

public Map<String,String> getExtractableFields()

Description copied from interface: Schema

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

Specified by:

getExtractableFields in interface Schema

Returns:

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

setExtractableFields

public void setExtractableFields(Map<String,String> extractableFields)

Description copied from interface: Schema

Set the extractable fields.

Specified by:

setExtractableFields in interface Schema

Parameters:

extractableFields - The extractable fields.

See Also:

Schema.getExtractableFields()

addExtractableField

public void addExtractableField(String label,
                                String jsonPath)

Description copied from interface: Schema

Add a single field to the map of extractable fields.

Specified by:

addExtractableField in interface Schema

Parameters:

label - The label of the field.

jsonPath - JSON path expression.

getCategories

public List<Category> getCategories()

Specified by:

getCategories in interface Schema

getRuleCheckers

public List<RuleChecker> getRuleCheckers()

Specified by:

getRuleCheckers in interface Schema

getHeader

public List<String> getHeader()

Specified by:

getHeader in interface CsvAwareSchema

toString

public String toString()

Overrides:

toString in class Object