Class ScholixFlat
The standard Scholix data model is hierarchical: a Scholix object contains nested
ScholixResource objects for the source and target, each carrying structured sub-objects
(identifiers, publishers, collected-from information, etc.). Indexing nested objects in
ElasticSearch introduces complexity when querying across parent/child boundaries, so this bean
denormalises the full link into a single, flat document that is easy to index, filter and
aggregate directly.
Each instance describes one directed relationship between two scholarly research
objects (e.g. a dataset linked to a publication). Source and target descriptors are stored as
parallel lists where positional correspondence is preserved: element i of
sourcePid belongs to the PID scheme stored at element i of
sourcePidType, and likewise for the target.
Typical usage:
ScholixFlat link = new ScholixFlat();
link.setIdentifier("abc123");
link.setRelationType("isSupplementTo");
link.setSourceId("50|doi_dedup_____::...");
link.setSourceType("dataset");
link.setTargetId("50|doi_dedup_____::...");
link.setTargetType("publication");
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the unique identifier of this link record.Returns the names of the link providers that asserted this relationship.Returns the publication or assertion date of the link.Returns the type of relationship between source and target.Returns the pre-computed citation count of the source resource.Returns the internal D-Net identifier of the source resource.Returns the list of PID values for the source resource.Returns the list of PID scheme names for the source resource.Returns the names of the publishers of the source resource.Returns the sub-type of the source resource.Returns the high-level object type of the source resource.Returns the pre-computed citation count of the target resource.Returns the internal D-Net identifier of the target resource.Returns the list of PID values for the target resource.Returns the list of PID scheme names for the target resource.Returns the names of the publishers of the target resource.Returns the sub-type of the target resource.Returns the high-level object type of the target resource.voidsetIdentifier(String identifier) Sets the unique identifier of this link record.voidsetLinkProviders(List<String> linkProviders) Sets the names of the link providers that asserted this relationship.voidsetPublicationDate(String publicationDate) Sets the publication or assertion date of the link.voidsetRelationType(String relationType) Sets the type of relationship between source and target.voidsetSourceCitationCount(Long sourceCitationCount) Sets the pre-computed citation count of the source resource.voidsetSourceId(String sourceId) Sets the internal D-Net identifier of the source resource.voidsetSourcePid(List<String> sourcePid) Sets the list of PID values for the source resource.voidsetSourcePidType(List<String> sourcePidType) Sets the list of PID scheme names for the source resource.voidsetSourcePublisher(List<String> sourcePublisher) Sets the names of the publishers of the source resource.voidsetSourceSubType(String sourceSubType) Sets the sub-type of the source resource.voidsetSourceType(String sourceType) Sets the high-level object type of the source resource.voidsetTargetCitationCount(Long targetCitationCount) Sets the pre-computed citation count of the target resource.voidsetTargetId(String targetId) Sets the internal D-Net identifier of the target resource.voidsetTargetPid(List<String> targetPid) Sets the list of PID values for the target resource.voidsetTargetPidType(List<String> targetPidType) Sets the list of PID scheme names for the target resource.voidsetTargetPublisher(List<String> targetPublisher) Sets the names of the publishers of the target resource.voidsetTargetSubType(String targetSubType) Sets the sub-type of the target resource.voidsetTargetType(String targetType) Sets the high-level object type of the target resource.
-
Constructor Details
-
ScholixFlat
public ScholixFlat()
-
-
Method Details
-
getIdentifier
Returns the unique identifier of this link record.- Returns:
- the link identifier, or
nullif not set
-
setIdentifier
Sets the unique identifier of this link record.- Parameters:
identifier- the link identifier
-
getRelationType
Returns the type of relationship between source and target.- Returns:
- the relation type (e.g.
"isSupplementTo"), ornullif not set
-
setRelationType
Sets the type of relationship between source and target.- Parameters:
relationType- the relation type
-
getSourceId
Returns the internal D-Net identifier of the source resource.- Returns:
- the source D-Net identifier, or
nullif not set
-
setSourceId
Sets the internal D-Net identifier of the source resource.- Parameters:
sourceId- the source D-Net identifier
-
getSourceType
Returns the high-level object type of the source resource.- Returns:
- the source object type (e.g.
"dataset"), ornullif not set
-
setSourceType
Sets the high-level object type of the source resource.- Parameters:
sourceType- the source object type
-
getSourceSubType
Returns the sub-type of the source resource.- Returns:
- the source sub-type, or
nullif not available
-
setSourceSubType
Sets the sub-type of the source resource.- Parameters:
sourceSubType- the source sub-type
-
getSourcePid
Returns the list of PID values for the source resource. Positionally aligned withgetSourcePidType().- Returns:
- list of source PIDs, or
nullif not set
-
setSourcePid
Sets the list of PID values for the source resource. Must be kept positionally aligned withsourcePidType.- Parameters:
sourcePid- list of source PID values
-
getSourcePidType
Returns the list of PID scheme names for the source resource. Positionally aligned withgetSourcePid().- Returns:
- list of source PID types (e.g.
"doi"), ornullif not set
-
setSourcePidType
Sets the list of PID scheme names for the source resource. Must be kept positionally aligned withsourcePid.- Parameters:
sourcePidType- list of source PID scheme names
-
getSourcePublisher
Returns the names of the publishers of the source resource.- Returns:
- list of source publisher names, or
nullif not set
-
setSourcePublisher
Sets the names of the publishers of the source resource.- Parameters:
sourcePublisher- list of source publisher names
-
getTargetId
Returns the internal D-Net identifier of the target resource.- Returns:
- the target D-Net identifier, or
nullif not set
-
setTargetId
Sets the internal D-Net identifier of the target resource.- Parameters:
targetId- the target D-Net identifier
-
getTargetType
Returns the high-level object type of the target resource.- Returns:
- the target object type (e.g.
"literature"), ornullif not set
-
setTargetType
Sets the high-level object type of the target resource.- Parameters:
targetType- the target object type
-
getTargetSubType
Returns the sub-type of the target resource.- Returns:
- the target sub-type, or
nullif not available
-
setTargetSubType
Sets the sub-type of the target resource.- Parameters:
targetSubType- the target sub-type
-
getTargetPid
Returns the list of PID values for the target resource. Positionally aligned withgetTargetPidType().- Returns:
- list of target PIDs, or
nullif not set
-
setTargetPid
Sets the list of PID values for the target resource. Must be kept positionally aligned withtargetPidType.- Parameters:
targetPid- list of target PID values
-
getTargetPidType
Returns the list of PID scheme names for the target resource. Positionally aligned withgetTargetPid().- Returns:
- list of target PID types (e.g.
"doi"), ornullif not set
-
setTargetPidType
Sets the list of PID scheme names for the target resource. Must be kept positionally aligned withtargetPid.- Parameters:
targetPidType- list of target PID scheme names
-
getTargetPublisher
Returns the names of the publishers of the target resource.- Returns:
- list of target publisher names, or
nullif not set
-
setTargetPublisher
Sets the names of the publishers of the target resource.- Parameters:
targetPublisher- list of target publisher names
-
getLinkProviders
Returns the names of the link providers that asserted this relationship.- Returns:
- list of link provider names, or
nullif not set
-
setLinkProviders
Sets the names of the link providers that asserted this relationship.- Parameters:
linkProviders- list of link provider names
-
getPublicationDate
Returns the publication or assertion date of the link.- Returns:
- the publication date as a free-form string, or
nullif not available
-
setPublicationDate
Sets the publication or assertion date of the link.- Parameters:
publicationDate- the publication date as a free-form string
-
getSourceCitationCount
Returns the pre-computed citation count of the source resource.- Returns:
- the number of citations of the source, or
nullif not available
-
setSourceCitationCount
Sets the pre-computed citation count of the source resource.- Parameters:
sourceCitationCount- the number of citations of the source
-
getTargetCitationCount
Returns the pre-computed citation count of the target resource.- Returns:
- the number of citations of the target, or
nullif not available
-
setTargetCitationCount
Sets the pre-computed citation count of the target resource.- Parameters:
targetCitationCount- the number of citations of the target
-