Class MappingTSVWriterVisitor

java.lang.Object

org.incenp.obofoundry.sssom.slots.SlotVisitorBase<Mapping>

org.incenp.obofoundry.sssom.MappingTSVWriterVisitor

All Implemented Interfaces:

ISlotVisitor<Mapping>

public class MappingTSVWriterVisitor
extends SlotVisitorBase<Mapping>

A visitor to to turn the slots of a Mapping object into a list of values that can be written to a TSV or CSV file.

This class is primarily intended to be used by TSVWriter, but it may be reused whenever mappings need to be serialised into TSV or CSV.

After the slots of a Mapping object have been visited, use the getValues() methods to obtain a list of string values ready to be written to a TSV/CSV files. The values will be in the same order as the order in which the slots have been visited.

Constructor Summary

Constructors

Constructor	Description
MappingTSVWriterVisitor(PrefixManager prefixManager, List<ExtensionDefinition> extraSlots, boolean isCSV)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
List<String>	getValues()	Gets the values ready for writing.
void	reset()	Prepare this object for visiting a new Mapping object.
void	visit(DateSlot<Mapping> slot, Mapping object, LocalDate value)	Visits a date-typed slot.
void	visit(DoubleSlot<Mapping> slot, Mapping object, Double value)	Visits a double-typed slot.
void	visit(EntityReferenceSlot<Mapping> slot, Mapping object, String value)	Visits a slot that holds an entity reference.
void	visit(EntityReferenceSlot<Mapping> slot, Mapping object, List<String> values)	Visits a multi-valued slot that holds entity references.
void	visit(ExtensionSlot<Mapping> slot, Mapping object, Map<String, ExtensionValue> extensions)	Visits a slot that holds extension values (non-standard metadata).
void	visit(Slot<Mapping> slot, Mapping object, Object value)	Visits a generic slot.
void	visit(StringSlot<Mapping> slot, Mapping object, List<String> values)	Visits a multi-valued string-typed slot.

Methods inherited from class SlotVisitorBase

visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class Object

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

Constructor Details

MappingTSVWriterVisitor

public MappingTSVWriterVisitor(PrefixManager prefixManager,
 List<ExtensionDefinition> extraSlots,
 boolean isCSV)

Creates a new instance.

Parameters:

prefixManager - The prefix manager to use to shorten entity references into their CURIE forms.

extraSlots - The definitions for the extension slots; if null, any extension slot will be ignored.

isCSV - If true, the values will be generated so that they can written to a CSV file. The default is to prepare values suitable for writing to a TSV file.

Method Details

getValues

public List<String> getValues()

Gets the values ready for writing.

Returns:

The list of strings representing the values for all the slots of the visited Mapping.

reset

public void reset()

Prepare this object for visiting a new Mapping object.

visit

public void visit(Slot<Mapping> slot,
 Mapping object,
 Object value)

Description copied from interface: ISlotVisitor

Visits a generic slot.

This method is normally not used as all slots in a SSSOM object have more precise types. But it can be used to implement behaviours that should be common to several slot types.

Specified by:

visit in interface ISlotVisitor<Mapping>

Overrides:

visit in class SlotVisitorBase<Mapping>

Parameters:

slot - The slot that is being visited.

object - The object to which the slot is attached.

value - The value of the slot.

visit

public void visit(EntityReferenceSlot<Mapping> slot,
 Mapping object,
 String value)

Description copied from interface: ISlotVisitor

Visits a slot that holds an entity reference.

Specified by:

visit in interface ISlotVisitor<Mapping>

Overrides:

visit in class SlotVisitorBase<Mapping>

Parameters:

slot - The slot that is being visited.

object - The object to which the slot is attached.

value - The value of the slot.

visit

public void visit(StringSlot<Mapping> slot,
 Mapping object,
 List<String> values)

Description copied from interface: ISlotVisitor

Visits a multi-valued string-typed slot.

Specified by:

visit in interface ISlotVisitor<Mapping>

Overrides:

visit in class SlotVisitorBase<Mapping>

Parameters:

slot - The slot that is being visited.

object - The object to which the slot is attached.

values - The values of the slot.

visit

public void visit(EntityReferenceSlot<Mapping> slot,
 Mapping object,
 List<String> values)

Description copied from interface: ISlotVisitor

Visits a multi-valued slot that holds entity references.

Specified by:

visit in interface ISlotVisitor<Mapping>

Overrides:

visit in class SlotVisitorBase<Mapping>

Parameters:

slot - The slot that is being visited.

object - The object to which the slot is attached.

values - The values of the slot.

visit

public void visit(DoubleSlot<Mapping> slot,
 Mapping object,
 Double value)

Description copied from interface: ISlotVisitor

Visits a double-typed slot.

Specified by:

visit in interface ISlotVisitor<Mapping>

Overrides:

visit in class SlotVisitorBase<Mapping>

Parameters:

slot - The slot that is being visited.

object - The object to which the slot is attached.

value - The value of the slot.

visit

public void visit(DateSlot<Mapping> slot,
 Mapping object,
 LocalDate value)

Description copied from interface: ISlotVisitor

Visits a date-typed slot.

Specified by:

visit in interface ISlotVisitor<Mapping>

Overrides:

visit in class SlotVisitorBase<Mapping>

Parameters:

slot - The slot that is being visited.

object - The object to which the slot is attached.

value - The value of the slot.

visit

public void visit(ExtensionSlot<Mapping> slot,
 Mapping object,
 Map<String, ExtensionValue> extensions)

Description copied from interface: ISlotVisitor

Visits a slot that holds extension values (non-standard metadata).

Specified by:

visit in interface ISlotVisitor<Mapping>

Overrides:

visit in class SlotVisitorBase<Mapping>

Parameters:

slot - The slot that is being visited.

object - The object to which the slot is attached.

extensions - The values of the slot.