Package de.gwdg.metadataqa.marc.definition.structure

Class SubfieldDefinition

java.lang.Object

de.gwdg.metadataqa.marc.definition.structure.SubfieldDefinition

All Implemented Interfaces:

Serializable

public class SubfieldDefinition
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeList	codeList

Constructor Summary

Constructors

Constructor	Description
SubfieldDefinition(String code, String label)	Create a MarcSubfield object
SubfieldDefinition(String code, String label, boolean repeatable)
SubfieldDefinition(String code, String label, String cardinalityCode)

Method Summary

Modifier and Type	Method	Description
SubfieldDefinition	disallowIn(MarcVersion... versions)
List<String>	getAllowedCodes()
String	getBibframeTag()
Cardinality	getCardinality()
String	getCardinalityCode()
String	getCode()
EncodedValue	getCode(String code)	Get the EncodedValue object (label+code) from the list of codes of this subfield for the given code.
EncodedValue	getCode(List<EncodedValue> codes, String code)	Get the EncodedValue object (label+code) for a given subfield code.
String	getCodeForIndex()	Returns the subfield code needed for Solr indexing.
CodeList	getCodeList()
List<EncodedValue>	getCodes()
SubfieldContentParser	getContentParser()
SubfieldContentSplitter	getContentSplitter()
List<MarcVersion>	getDisallowedIn()
List<FRBRFunction>	getFrbrFunctions()
String	getLabel()
EncodedValue	getLocalCode(MarcVersion version, String code)
Map<MarcVersion,List<EncodedValue>>	getLocalCodes()
List<EncodedValue>	getLocalCodes(MarcVersion version)
MarcVersion	getMarcVersion()
CompilanceLevel	getMinimalCompilanceLevel()
String	getMqTag()
CompilanceLevel	getNationalCompilanceLevel()
BibliographicFieldDefinition	getParent()
String	getPath()
ControlfieldPositionDefinition	getPosition(int start, int end)
List<ControlfieldPositionDefinition>	getPositions()
SubfieldValidator	getValidator()
boolean	hasCodeList()
void	hasCodeList(boolean hasCodeList)
boolean	hasContentParser()
boolean	hasContentSplitter()
boolean	hasPositions()
boolean	hasValidator()
boolean	isDisallowedIn(MarcVersion marcVersion)
boolean	isRepeatable()
String	resolve(String value)	Resolves the value of a subfield to its label if it can be found in the codeList or the list of codes.
Map<String,String>	resolvePositional(String value)
SubfieldDefinition	setBibframeTag(String bibframeTag)
SubfieldDefinition	setCodeList(CodeList codeList)
SubfieldDefinition	setCodes(String... input)
SubfieldDefinition	setCodes(List<EncodedValue> codes)
SubfieldDefinition	setCompilanceLevels(String national)
SubfieldDefinition	setCompilanceLevels(String national, String minimal)
SubfieldDefinition	setContentParser(SubfieldContentParser contentParser)
SubfieldDefinition	setContentSplitter(SubfieldContentSplitter contentSplitter)
SubfieldDefinition	setFrbrFunctions(FRBRFunction... functions)
SubfieldDefinition	setLocalCodes(MarcVersion version, String... input)	Local codes are defined by a particular library, not in the LoC MARC21 definition
void	setMarcVersion(MarcVersion marcVersion)
SubfieldDefinition	setMinimalCompilanceLevel(CompilanceLevel minimalLevel)
SubfieldDefinition	setMinimalCompilanceLevel(String level)
SubfieldDefinition	setMqTag(String mqTag)
SubfieldDefinition	setNationalCompilanceLevel(CompilanceLevel nationalLevel)
SubfieldDefinition	setNationalCompilanceLevel(String level)
SubfieldDefinition	setParent(BibliographicFieldDefinition parent)
void	setPositions(List<ControlfieldPositionDefinition> positions)
SubfieldDefinition	setValidator(SubfieldValidator validator)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

codeList

protected CodeList codeList

Constructor Details

SubfieldDefinition

public SubfieldDefinition(String code,
 String label)

Create a MarcSubfield object

Parameters:

code - The subfield code

label - The description of the code

SubfieldDefinition

public SubfieldDefinition(String code,
 String label,
 String cardinalityCode)

SubfieldDefinition

public SubfieldDefinition(String code,
 String label,
 boolean repeatable)

Method Details

getCodeForIndex

public String getCodeForIndex()

Returns the subfield code needed for Solr indexing. If MQ or BIBFRAME tags are defined, they are used in that order. Otherwise, the code is prefixed with an underscore (and special characters are replaced with their names). Note: The code that's referred to here is the identifier of the subfield and not code in the sense of possible values of the subfield.

Returns:

The subfield code for Solr indexing.

getCode

public String getCode()

getPath

public String getPath()

setCodes

public SubfieldDefinition setCodes(List<EncodedValue> codes)

setCodes

public SubfieldDefinition setCodes(String... input)

setLocalCodes

public SubfieldDefinition setLocalCodes(MarcVersion version,
 String... input)

Local codes are defined by a particular library, not in the LoC MARC21 definition

Parameters:

version -

input -

Returns:

getCode

public EncodedValue getCode(String code)

Get the EncodedValue object (label+code) from the list of codes of this subfield for the given code.

Parameters:

code - The code to look up.

Returns:

The EncodedValue object for the given code or null if not found.

getCode

public EncodedValue getCode(List<EncodedValue> codes,
 String code)

Get the EncodedValue object (label+code) for a given subfield code.

Parameters:

codes - The list of EncodedValue objects (codes of the subfield).

code - The code to look up.

Returns:

The EncodedValue object for the given code or null if not found.

getCodes

public List<EncodedValue> getCodes()

getLocalCodes

public Map<MarcVersion,List<EncodedValue>> getLocalCodes()

getLocalCodes

public List<EncodedValue> getLocalCodes(MarcVersion version)

getLocalCode

public EncodedValue getLocalCode(MarcVersion version,
 String code)

getCardinalityCode

public String getCardinalityCode()

getCardinality

public Cardinality getCardinality()

getLabel

public String getLabel()

getAllowedCodes

public List<String> getAllowedCodes()

getContentParser

public SubfieldContentParser getContentParser()

hasContentParser

public boolean hasContentParser()

setContentParser

public SubfieldDefinition setContentParser(SubfieldContentParser contentParser)

hasContentSplitter

public boolean hasContentSplitter()

getContentSplitter

public SubfieldContentSplitter getContentSplitter()

setContentSplitter

public SubfieldDefinition setContentSplitter(SubfieldContentSplitter contentSplitter)

setValidator

public SubfieldDefinition setValidator(SubfieldValidator validator)

hasValidator

public boolean hasValidator()

getValidator

public SubfieldValidator getValidator()

setCodeList

public SubfieldDefinition setCodeList(CodeList codeList)

getCodeList

public CodeList getCodeList()

resolve

public String resolve(String value)

Resolves the value of a subfield to its label if it can be found in the codeList or the list of codes. Otherwise, it returns the value as is.

Parameters:

value - The value of the subfield to resolve.

Returns:

The resolved value. Either the label of the code or the value itself.

resolvePositional

public Map<String,String> resolvePositional(String value)

getBibframeTag

public String getBibframeTag()

setBibframeTag

public SubfieldDefinition setBibframeTag(String bibframeTag)

getMqTag

public String getMqTag()

getParent

public BibliographicFieldDefinition getParent()

getFrbrFunctions

public List<FRBRFunction> getFrbrFunctions()

setParent

public SubfieldDefinition setParent(BibliographicFieldDefinition parent)

setMqTag

public SubfieldDefinition setMqTag(String mqTag)

setPositions

public void setPositions(List<ControlfieldPositionDefinition> positions)

getPositions

public List<ControlfieldPositionDefinition> getPositions()

hasPositions

public boolean hasPositions()

getPosition

public ControlfieldPositionDefinition getPosition(int start,
 int end)

setCompilanceLevels

public SubfieldDefinition setCompilanceLevels(String national)

setCompilanceLevels

public SubfieldDefinition setCompilanceLevels(String national,
 String minimal)

getNationalCompilanceLevel

public CompilanceLevel getNationalCompilanceLevel()

setNationalCompilanceLevel

public SubfieldDefinition setNationalCompilanceLevel(CompilanceLevel nationalLevel)

setNationalCompilanceLevel

public SubfieldDefinition setNationalCompilanceLevel(String level)

getMinimalCompilanceLevel

public CompilanceLevel getMinimalCompilanceLevel()

setMinimalCompilanceLevel

public SubfieldDefinition setMinimalCompilanceLevel(String level)

setMinimalCompilanceLevel

public SubfieldDefinition setMinimalCompilanceLevel(CompilanceLevel minimalLevel)

setFrbrFunctions

public SubfieldDefinition setFrbrFunctions(FRBRFunction... functions)

disallowIn

public SubfieldDefinition disallowIn(MarcVersion... versions)

getDisallowedIn

public List<MarcVersion> getDisallowedIn()

isDisallowedIn

public boolean isDisallowedIn(MarcVersion marcVersion)

getMarcVersion

public MarcVersion getMarcVersion()

setMarcVersion

public void setMarcVersion(MarcVersion marcVersion)

isRepeatable

public boolean isRepeatable()

hasCodeList

public boolean hasCodeList()

hasCodeList

public void hasCodeList(boolean hasCodeList)

toString

public String toString()

Overrides:

toString in class Object