org.gedcomx.conclusion
Class EventRole

java.lang.Object
  org.gedcomx.common.ExtensibleData
      org.gedcomx.links.HypermediaEnabledData
          org.gedcomx.conclusion.Conclusion
              org.gedcomx.conclusion.EventRole

All Implemented Interfaces:

Attributable, HasNotes, HasTransientProperties, SupportsLinks, SupportsExtensionElements, ReferencesSources

public class EventRole
extends Conclusion

A role that a specific person plays in an event.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

EventRole()

Method Summary

void	accept(GedcomxModelVisitor visitor) Accept a visitor.
EventRole	analysis(Document analysis) Add a reference to the analysis for this conclusion.
EventRole	analysis(ResourceReference analysis) Add a reference to the analysis for this conclusion.
EventRole	analysis(URI analysis) Add a reference to the analysis for this conclusion.
EventRole	attribution(Attribution attribution) Build up this conclusion with attribution.
EventRole	confidence(ConfidenceLevel confidence) Build up this conclusion with a confidence level.
EventRole	confidence(URI confidence) Build up this conclusion with a confidence level.
EventRole	details(String details) Build up this event role with details.
String	getDetails() Details about the role of the person in the event.
EventRoleType	getKnownType() The enum referencing the known role type, or EventRoleType.OTHER if not known.
ResourceReference	getPerson() Reference to the person playing the role in the event.
URI	getType() The role type.
EventRole	id(String id) Build up this object with an id.
EventRole	lang(String lang) Build up this conclusion with a lang.
EventRole	link(Link link) Build up this data with a link.
EventRole	link(String rel, URI href) Build up this data with a link.
EventRole	note(Note note) Build up this conclusion with a note.
EventRole	person(Person person) Build up this event role with a person.
EventRole	person(ResourceReference person) Build up this event role with a person.
void	setDetails(String details) Details about the role of the person in the event.
void	setKnownType(EventRoleType knownType) Set the role type from an enumeration of known role types.
void	setPerson(ResourceReference person) Reference to the person playing the role in the event.
void	setType(URI type) The role type.
EventRole	sortKey(String sortKey) Build up this fact with a sort key.
EventRole	source(SourceDescription source) Build up this conclusion with a source reference.
EventRole	source(SourceReference sourceReference) Build up this conclusion with a source reference.
String	toString() Provide a simple toString() method.
EventRole	type(EventRoleType type) Build up this role with a type.
EventRole	type(URI type) Build up this role with a type.

Methods inherited from class org.gedcomx.conclusion.Conclusion

addNote, addSource, embed, getAnalysis, getAttribution, getConfidence, getKnownConfidenceLevel, getLang, getNotes, getSortKey, getSources, setAnalysis, setAttribution, setConfidence, setKnownConfidenceLevel, setLang, setNotes, setSortKey, setSources

Methods inherited from class org.gedcomx.links.HypermediaEnabledData

addLink, addLink, addTemplatedLink, embed, getLink, getLinks, getLinks, setLinks

Methods inherited from class org.gedcomx.common.ExtensibleData

addExtensionElement, embed, findExtensionOfType, findExtensionOfType, findExtensionsOfType, findExtensionsOfType, getExtensionElements, getId, getTransientProperties, getTransientProperty, removeExtensionElements, setExtensionElement, setExtensionElements, setId, setTransientProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

EventRole

public EventRole()

Method Detail

id

public EventRole id(String id)

Description copied from class: ExtensibleData

Build up this object with an id.

Overrides:

id in class Conclusion

Parameters:

id - The id.

link

public EventRole link(String rel,
                      URI href)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class Conclusion

Parameters:

rel - The rel.

href - The href.

Returns:

this.

link

public EventRole link(Link link)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class Conclusion

Parameters:

link - The link.

Returns:

this.

lang

public EventRole lang(String lang)

Description copied from class: Conclusion

Build up this conclusion with a lang.

Overrides:

lang in class Conclusion

Parameters:

lang - The lang.

Returns:

this.

confidence

public EventRole confidence(URI confidence)

Description copied from class: Conclusion

Build up this conclusion with a confidence level.

Overrides:

confidence in class Conclusion

Parameters:

confidence - The confidence level.

Returns:

this.

confidence

public EventRole confidence(ConfidenceLevel confidence)

Description copied from class: Conclusion

Build up this conclusion with a confidence level.

Overrides:

confidence in class Conclusion

Parameters:

confidence - The confidence level.

Returns:

this.

source

public EventRole source(SourceReference sourceReference)

Description copied from class: Conclusion

Build up this conclusion with a source reference.

Overrides:

source in class Conclusion

Parameters:

sourceReference - The source reference.

Returns:

this.

source

public EventRole source(SourceDescription source)

Description copied from class: Conclusion

Build up this conclusion with a source reference.

Overrides:

source in class Conclusion

Parameters:

source - The source description being referenced.

Returns:

this.

note

public EventRole note(Note note)

Description copied from class: Conclusion

Build up this conclusion with a note.

Overrides:

note in class Conclusion

Parameters:

note - The note.

Returns:

this.

attribution

public EventRole attribution(Attribution attribution)

Description copied from class: Conclusion

Build up this conclusion with attribution.

Overrides:

attribution in class Conclusion

Parameters:

attribution - The attribution.

Returns:

this.

analysis

public EventRole analysis(ResourceReference analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Conclusion

Parameters:

analysis - The analysis.

Returns:

this.

analysis

public EventRole analysis(URI analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Conclusion

Parameters:

analysis - The analysis.

Returns:

this.

analysis

public EventRole analysis(Document analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Conclusion

Parameters:

analysis - The analysis.

Returns:

this.

sortKey

public EventRole sortKey(String sortKey)

Description copied from class: Conclusion

Build up this fact with a sort key.

Overrides:

sortKey in class Conclusion

Parameters:

sortKey - The sort key.

Returns:

this.

getPerson

public ResourceReference getPerson()

Reference to the person playing the role in the event.

Returns:

Reference to the person playing the role in the event.

setPerson

public void setPerson(ResourceReference person)

Reference to the person playing the role in the event.

Parameters:

person - Reference to the person playing the role in the event.

person

public EventRole person(ResourceReference person)

Build up this event role with a person.

Parameters:

person - The person.

Returns:

this.

person

public EventRole person(Person person)

Build up this event role with a person.

Parameters:

person - The person.

Returns:

this.

getType

public URI getType()

The role type.

Returns:

The role type.

setType

public void setType(URI type)

The role type.

Parameters:

type - The role type.

type

public EventRole type(URI type)

Build up this role with a type.

Parameters:

type - The type.

Returns:

this.

type

public EventRole type(EventRoleType type)

Build up this role with a type.

Parameters:

type - The type.

Returns:

this.

getKnownType

public EventRoleType getKnownType()

The enum referencing the known role type, or EventRoleType.OTHER if not known.

Returns:

The enum referencing the known role type, or EventRoleType.OTHER if not known.

setKnownType

public void setKnownType(EventRoleType knownType)

Set the role type from an enumeration of known role types.

Parameters:

knownType - The role type.

getDetails

public String getDetails()

Details about the role of the person in the event.

Returns:

Details about the role of the person in the event.

setDetails

public void setDetails(String details)

Details about the role of the person in the event.

Parameters:

details - Details about the role of the person in the event.

details

public EventRole details(String details)

Build up this event role with details.

Parameters:

details - The details.

Returns:

this.

toString

public String toString()

Provide a simple toString() method.

Overrides:

toString in class Conclusion

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.