public class SourceDescription extends HypermediaEnabledData implements Attributable, HasNotes, ReferencesSources
extensionElements, transientProperties| Constructor and Description |
|---|
SourceDescription() |
| Modifier and Type | Method and Description |
|---|---|
SourceDescription |
about(URI about)
Build out this source description with an about reference.
|
void |
accept(GedcomxModelVisitor visitor)
Accept a visitor.
|
void |
addCitation(SourceCitation citation)
Add a citation.
|
void |
addField(Field field)
Add a field to the source description.
|
void |
addKnownStatus(ResourceStatusType status)
Add the given ResourceStatusType's URI to the list of statuses.
|
void |
addRights(URI rights)
Add a rights.
|
void |
addStatus(URI status)
Add the given resource status type URI to the list of statuses.
|
SourceDescription |
analysis(ResourceReference analysis)
Build out this source description with an analyis.
|
SourceDescription |
attribution(Attribution attribution)
Build out this source description with attribution.
|
SourceDescription |
citation(SourceCitation citation)
Build out this source description with a citation.
|
SourceDescription |
citation(String citation)
Build out this source description with a citation.
|
SourceDescription |
componentOf(SourceDescription componentOf)
Build out this source description with a component of.
|
SourceDescription |
componentOf(SourceReference componentOf)
Build out this source description with a component of.
|
SourceDescription |
coverage(Coverage coverage)
Build out this source description with coverage.
|
SourceDescription |
created(Date created)
Build out this source description with a created date.
|
SourceDescription |
description(String description)
Build out this source description with a description.
|
SourceDescription |
description(TextValue description)
Build out this source description with a description.
|
SourceDescription |
descriptorRef(ResourceReference descriptorRef)
Build out this source description with a descriptor ref.
|
void |
embed(SourceDescription description)
Embed the specified description.
|
SourceDescription |
extensionElement(Object element) |
SourceDescription |
field(Field field)
Build this out with a field.
|
URI |
getAbout()
The URI (if applicable) of the actual source.
|
ResourceReference |
getAnalysis()
A reference to the analysis document explaining the analysis that went into this description of the source.
|
Attribution |
getAttribution()
The attribution metadata for this source description.
|
SourceCitation |
getCitation()
The preferred bibliographic citation for this source.
|
List<SourceCitation> |
getCitations()
The bibliographic citations for this source.
|
SourceReference |
getComponentOf()
A reference to the source that contains this source.
|
List<Coverage> |
getCoverage()
Declarations of the coverage of the source.
|
Date |
getCreated()
The date the source was created.
|
List<TextValue> |
getDescriptions()
Human-readable descriptions of the source.
|
ResourceReference |
getDescriptorRef()
Reference to a descriptor of fields and type of data that can be expected to be extracted from the source.
|
List<Field> |
getFields()
The fields that are applicable to the resource being described.
|
List<Identifier> |
getIdentifiers()
The list of identifiers for the source.
|
ResourceType |
getKnownType()
The type of the resource being described.
|
String |
getLang()
The language of this genealogical data set.
|
ResourceReference |
getMediator()
A reference to the entity that mediates access to the described source.
|
String |
getMediaType()
Hint about the media (MIME) type of the resource being described.
|
Date |
getModified()
The date the source was last modified.
|
List<Note> |
getNotes()
Notes about a source.
|
URI |
getPersistentId()
Find the long-term, persistent identifier for this source from the list of identifiers.
|
URI |
getReplacedBy()
The URI that this resource has been replaced by.
|
List<URI> |
getReplaces()
The list of resources that this resource replaces.
|
ResourceReference |
getRepository()
Reference to an agent describing the repository in which the source is found.
|
URI |
getResourceType()
The type of the resource being described.
|
List<URI> |
getRights()
The rights for this source.
|
String |
getSortKey()
A sort key to be used in determining the position of this source relative to other sources in the same collection.
|
List<SourceReference> |
getSources()
References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).
|
List<URI> |
getStatuses()
The list of status types for the source.
|
TextValue |
getTitle()
The preferred title for this source description.
|
TextValue |
getTitleLabel()
A label for the title of this description.
|
List<TextValue> |
getTitles()
A list of titles for this source.
|
String |
getVersion()
gets the version of this resource
|
SourceDescription |
id(String id)
Build up this object with an id.
|
SourceDescription |
identifier(Identifier identifier)
Build out this source description with an identifier.
|
SourceDescription |
lang(String lang)
Build out this envelope with a lang.
|
SourceDescription |
link(Link link)
Build up this data with a link.
|
SourceDescription |
link(String rel,
URI href)
Build up this data with a link.
|
SourceDescription |
mediator(ResourceReference mediator)
Build out this source description with a mediator.
|
SourceDescription |
mediaType(String mediaType)
Build out this source description with a media type.
|
SourceDescription |
modified(Date modified)
Build out this source description with a modified date.
|
SourceDescription |
note(Note note)
Build out this source description with a note.
|
SourceDescription |
repository(Agent repository)
Build out this source description with a repository.
|
SourceDescription |
repository(ResourceReference repository)
Build out this source description with a repository.
|
SourceDescription |
resourceType(ResourceType resourceType)
Build of this source description with a resource type.
|
SourceDescription |
resourceType(URI resourceType)
Build of this source description with a resource type.
|
SourceDescription |
rights(URI rights)
Build out this source description with a rights.
|
void |
setAbout(URI about)
The URI (if applicable) of the actual source.
|
void |
setAnalysis(ResourceReference analysis)
A reference to the analysis document explaining the analysis that went into this description of the source.
|
void |
setAttribution(Attribution attribution)
The attribution metadata for this source description.
|
void |
setCitations(List<SourceCitation> citations)
The bibliographic citations for this source.
|
void |
setComponentOf(SourceReference componentOf)
A reference to the source that contains this source.
|
void |
setCoverage(List<Coverage> coverage)
Declarations of the coverage of the source.
|
void |
setCreated(Date created)
The date the source was created.
|
void |
setDescriptions(List<TextValue> descriptions)
Human-readable descriptions of the source.
|
void |
setDescriptorRef(ResourceReference descriptorRef)
Reference to a descriptor of fields and type of data that can be expected to be extracted from the source.
|
void |
setFields(List<Field> fields)
The fields that are applicable to the resource being described.
|
void |
setIdentifiers(List<Identifier> identifiers)
The list of identifiers of the source.
|
void |
setKnownType(ResourceType type)
The type of the resource being described.
|
void |
setLang(String lang)
The language of this genealogical data set.
|
void |
setMediator(ResourceReference mediator)
A reference to the entity that mediates access to the described source.
|
void |
setMediatorURI(URI mediator)
A reference to the entity that mediates access to the described source.
|
void |
setMediaType(String mediaType)
Hint about the media (MIME) type of the resource being described.
|
void |
setModified(Date modified)
The date the source was last modified.
|
void |
setNotes(List<Note> notes)
Notes about a source.
|
void |
setPersistentId(URI persistentId)
A long-term, persistent, globally unique identifier for this source.
|
void |
setReplacedBy(URI replacedBy)
The URI that this resource has been replaced by.
|
void |
setReplaces(List<URI> replaces)
The list of resources that this resource replaces.
|
void |
setRepository(ResourceReference repository)
Reference to an agent describing the repository in which the source is found.
|
void |
setResourceType(URI resourceType)
The type of the resource being described.
|
void |
setRights(List<URI> rights)
The rights for this source.
|
void |
setSortKey(String sortKey)
A sort key to be used in determining the position of this source relative to other sources in the same collection.
|
void |
setSources(List<SourceReference> sources)
References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).
|
void |
setStatuses(List<URI> statuses)
The list of status types for the source.
|
void |
setTitleLabel(TextValue titleLabel)
A label for the title of this description.
|
void |
setTitles(List<TextValue> titles)
A list of titles for this source.
|
void |
setVersion(String version)
sets the version of this resource
|
SourceDescription |
sortKey(String sortKey)
Build out this source description with a sort key.
|
SourceDescription |
source(SourceReference source)
Build out this source description by adding a source reference.
|
SourceDescription |
title(String title)
Build out this source description with a title.
|
SourceDescription |
title(TextValue title)
Build out this source description with a title.
|
SourceDescription |
titleLabel(TextValue titleLabel)
Build this out by applying a label for the title of this description.
|
String |
toString()
Provide a simple toString() method.
|
SourceDescription |
version(String version)
Build out this source description with a version.
|
addLink, addLink, addTemplatedLink, embed, getLink, getLinks, getLinks, setLinksaddExtensionElement, embed, findExtensionOfType, findExtensionOfType, findExtensionsOfType, findExtensionsOfType, getExtensionElements, getId, getTransientProperties, getTransientProperty, removeExtensionElements, setExtensionElement, setExtensionElements, setId, setTransientPropertypublic String getLang()
public void setLang(String lang)
lang - The language of this genealogical data.public SourceDescription lang(String lang)
lang - The lang.public SourceDescription id(String id)
ExtensibleDataid in class ExtensibleDataid - The id.public SourceDescription extensionElement(Object element)
extensionElement in class ExtensibleDatapublic SourceDescription link(String rel, URI href)
HypermediaEnabledDatalink in class HypermediaEnabledDatarel - The rel.href - The href.public SourceDescription link(Link link)
HypermediaEnabledDatalink in class HypermediaEnabledDatalink - The link.public URI getResourceType()
public void setResourceType(URI resourceType)
resourceType - The type of the resource being described.public SourceDescription resourceType(URI resourceType)
resourceType - The resource type.public SourceDescription resourceType(ResourceType resourceType)
resourceType - The resource type.public ResourceType getKnownType()
public void setKnownType(ResourceType type)
type - The type of the resource being described.public List<URI> getRights()
public void setRights(List<URI> rights)
rights - The rights for this source.public SourceDescription rights(URI rights)
rights - The rights.public void addRights(URI rights)
rights - The rights to be added.public SourceCitation getCitation()
public List<SourceCitation> getCitations()
public void setCitations(List<SourceCitation> citations)
citations - The bibliographic citations for this source.public SourceDescription citation(SourceCitation citation)
citation - The citation.public SourceDescription citation(String citation)
citation - The citation.public void addCitation(SourceCitation citation)
citation - The citation to be added.public String getMediaType()
public void setMediaType(String mediaType)
mediaType - Hint about the media (MIME) type of the resource being described.public SourceDescription mediaType(String mediaType)
mediaType - The media type.public URI getAbout()
public void setAbout(URI about)
about - The URI (if applicable) of the actual source.public SourceDescription about(URI about)
about - the about.public ResourceReference getMediator()
public void setMediator(ResourceReference mediator)
mediator - A reference to the entity that mediates access to the described source.public SourceDescription mediator(ResourceReference mediator)
mediator - The mediator.public void setMediatorURI(URI mediator)
mediator - A reference to the entity that mediates access to the described source.public List<SourceReference> getSources()
getSources in interface ReferencesSourcespublic void setSources(List<SourceReference> sources)
setSources in interface ReferencesSourcessources - References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source).public SourceDescription source(SourceReference source)
source - The source reference.public ResourceReference getAnalysis()
public void setAnalysis(ResourceReference analysis)
analysis - A reference to the analysis document explaining the analysis that went into this description of the source.public SourceDescription analysis(ResourceReference analysis)
analysis - The analysis.public SourceReference getComponentOf()
public void setComponentOf(SourceReference componentOf)
componentOf - A reference to the source that contains this source.public SourceDescription componentOf(SourceReference componentOf)
componentOf - The component of.public SourceDescription componentOf(SourceDescription componentOf)
componentOf - The component of.public TextValue getTitle()
public List<TextValue> getTitles()
public void setTitles(List<TextValue> titles)
titles - A list of titles for this source.public SourceDescription title(TextValue title)
title - The title.public SourceDescription title(String title)
title - The title.public TextValue getTitleLabel()
public void setTitleLabel(TextValue titleLabel)
titleLabel - A label for the title of this description.public SourceDescription titleLabel(TextValue titleLabel)
titleLabel - The title label.public SourceDescription note(Note note)
note - the note.public Attribution getAttribution()
getAttribution in interface Attributablepublic void setAttribution(Attribution attribution)
setAttribution in interface Attributableattribution - The attribution metadata for this source description.public SourceDescription attribution(Attribution attribution)
attribution - The attribution.public void accept(GedcomxModelVisitor visitor)
visitor - The visitor.public URI getPersistentId()
public void setPersistentId(URI persistentId)
persistentId - A long-term, persistent, globally unique identifier for this source.public URI getReplacedBy()
public void setReplacedBy(URI replacedBy)
replacedBy - - URI of a resource that replaces this one.public List<URI> getReplaces()
public void setReplaces(List<URI> replaces)
replaces - The list of identifiers of the source.public List<URI> getStatuses()
public void setStatuses(List<URI> statuses)
statuses - The list of identifiers of the source.public void addKnownStatus(ResourceStatusType status)
status - - ResourceStatusType to add to the statuses list.public void addStatus(URI status)
status - - URI to add to the list of statuses.public List<Identifier> getIdentifiers()
public void setIdentifiers(List<Identifier> identifiers)
identifiers - The list of identifiers of the source.public SourceDescription identifier(Identifier identifier)
identifier - the identifier.public String getSortKey()
public void setSortKey(String sortKey)
sortKey - A sort key to be used in determining the position of this source relative to other sources in the same collection.public SourceDescription sortKey(String sortKey)
sortKey - The sort key.public List<TextValue> getDescriptions()
public void setDescriptions(List<TextValue> descriptions)
descriptions - Human-readable descriptions of the source.public SourceDescription description(TextValue description)
description - The description.public SourceDescription description(String description)
description - The description.public Date getCreated()
public void setCreated(Date created)
created - The date the source was created.public SourceDescription created(Date created)
created - The created date.public Date getModified()
public void setModified(Date modified)
modified - The date the source was last modified.public SourceDescription modified(Date modified)
modified - the modified date.public List<Coverage> getCoverage()
public void setCoverage(List<Coverage> coverage)
coverage - Declarations of the coverage of the source.public SourceDescription coverage(Coverage coverage)
coverage - The coverage.public List<Field> getFields()
public void setFields(List<Field> fields)
fields - The fields that are applicable to the resource being described.public SourceDescription field(Field field)
field - The field.public void addField(Field field)
field - The field to be added.public ResourceReference getRepository()
public void setRepository(ResourceReference repository)
repository - Reference to an agent describing the repository in which the source is found.public SourceDescription repository(Agent repository)
repository - The repository.public SourceDescription repository(ResourceReference repository)
repository - The repository.public ResourceReference getDescriptorRef()
public void setDescriptorRef(ResourceReference descriptorRef)
descriptorRef - Reference to a descriptor of fields and type of data that can be expected to be extracted from the source.public SourceDescription descriptorRef(ResourceReference descriptorRef)
descriptorRef - The descriptor ref.public String getVersion()
public void setVersion(String version)
version - the version of this resourcepublic SourceDescription version(String version)
version - the version of this resourcepublic void embed(SourceDescription description)
description - The description to embed.public String toString()
toString in class ExtensibleDataCopyright © 2016. All rights reserved.