Class: Relationship

Extends

• Subject

Methods

---

addEvidence(evidence)

Add evidence

Parameters:

Name	Type	Description
evidence	Object | EvidenceReference

Inherited From:

• Subject#addEvidence

Returns:

This instance.

Type

Subject

---

addFact(fact)

Add a fact

Parameters:

Name	Type	Description
fact	Fact | Object

Returns:

This instance

Type

Relationship

---

addField(field)

Add a field

Parameters:

Name	Type	Description
field	Field

Inherited From:

• ExtensibleData#addField

Returns:

this

Type

ExtensibleData

---

addLink(link)

Add a link

Parameters:

Name	Type	Description
link	Link

Inherited From:

• ExtensibleData#addLink

Returns:

this

Type

ExtensibleData

---

addMedia(media)

Add media

Parameters:

Name	Type	Description
media	Object | SourceReference

Inherited From:

• Subject#addMedia

Returns:

This instance.

Type

Subject

---

addNote(note)

Add a note

Parameters:

Name	Type	Description
note	Object | Note

Inherited From:

• Conclusion#addNote

Returns:

This instance

Type

Conclusion

---

addSource(source)

Add a source

Parameters:

Name	Type	Description
source	SourceReference

Inherited From:

• Conclusion#addSource

Returns:

This instance

Type

Conclusion

---

getAnalysis()

Get analysis.

Inherited From:

• Conclusion#getAnalysis

Returns:

analysis

Type

ResourceReference

---

getAttribution()

Get the attribution.

Inherited From:

• Conclusion#getAttribution

Returns:

Type

Attribution

---

getConfidence()

Get the confidence.

Inherited From:

• Conclusion#getConfidence

Returns:

confidence

Type

String

---

getEvidence()

Get the evidence.

Inherited From:

• Subject#getEvidence

Returns:

Type

Array.<EvidenceReference>

---

getFacts()

Get the facts

Returns:

Type

Array.<Fact>

---

getFields()

Get the fields

Inherited From:

• ExtensibleData#getFields

Returns:

Type

Array.<Field>

---

getId()

Get the object's id.

Inherited From:

• ExtensibleData#getId

Returns:

Id

Type

String

---

getIdentifiers()

Get the identifiers

Inherited From:

• Subject#getIdentifiers

Returns:

Type

Identifiers

---

getLang()

Get the language identifier.

Inherited From:

• Conclusion#getLang

Returns:

lang

Type

String

---

getLink(rel)

Get a link

Parameters:

Name	Type	Description
rel	String

Inherited From:

• ExtensibleData#getLink

Returns:

Type

Link

---

getLinks()

Get the links

Inherited From:

• ExtensibleData#getLinks

Returns:

Type

Array.<Link>

---

getMedia()

Get the media references

Inherited From:

• Subject#getMedia

Returns:

Type

Array.<SourceReference>

---

getNotes()

Get the notes

Inherited From:

• Conclusion#getNotes

Returns:

notes

Type

Array.<Note>

---

getOtherPerson(person)

Given a person in this relationships, return the other person's resource reference.

Parameters:

Name	Type	Description
person	Person | String	Person object or person ID

Returns:

Type

ResourceReference

---

getPerson1()

Get person1 reference

Returns:

Type

ResourceReference

---

getPerson2()

Get person2 reference

Returns:

Type

ResourceReference

---

getSortKey()

Get the sortKey

Inherited From:

• Conclusion#getSortKey

Returns:

sortKey

Type

Boolean

---

getSources()

Get the sources

Inherited From:

• Conclusion#getSources

Returns:

Type

Array.<SourceReference>

---

getType()

Get the relationship type

Returns:

type

Type

String

---

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
json	Object

Overrides:

• Subject#init

Returns:

this

Type

Relationship

---

involvesPerson(person)

Calculate whether a relationship involves a person

Parameters:

Name	Type	Description
person	Person | String	Person object or person ID

Returns:

Type

Boolean

---

isExtracted()

Is this an extracted conclusion?

Inherited From:

• Subject#isExtracted

Returns:

extracted

Type

Boolean

---

<static> isInstance(obj)

Check whether the given object is an instance of this class.

Parameters:

Name	Type	Description
obj	Object

Returns:

Type

Boolean

---

setAnalysis(analysis)

Set the analysis

Parameters:

Name	Type	Description
analysis	Object | ResourceReference

Inherited From:

• Conclusion#setAnalysis

Returns:

This instance

Type

Conclusion

---

setAttribution(attribution)

Set the attribution

Parameters:

Name	Type	Description
attribution	Object | Attribution

Inherited From:

• Conclusion#setAttribution

Returns:

This instance

Type

Conclusion

---

setConfidence(confidence)

Set the confidence.

Parameters:

Name	Type	Description
confidence	String

Inherited From:

• Conclusion#setConfidence

Returns:

This instance

Type

Conclusion

---

setEvidence(evidence)

Set the evidence. This method will replace existing evidence entries with new entries.

Parameters:

Name	Type	Description
evidence	Array.<Object> | Array.<EvidenceReference>

Inherited From:

• Subject#setEvidence

Returns:

This instance.

Type

Subject

---

setExtracted(extracted)

Set the extracted property

Parameters:

Name	Type	Description
extracted	Boolean

Inherited From:

• Subject#setExtracted

Returns:

This instance.

Type

Subject

---

setFacts(facts)

Set the facts

Parameters:

Name	Type	Description
facts	Array.<Fact> | Array.<Object>

Returns:

This instance

Type

Relationship

---

setFields(fields)

Set the fields

Parameters:

Name	Type	Description
fields	Array.<Field>

Inherited From:

• ExtensibleData#setFields

Returns:

this

Type

ExtensibleData

---

setId(id)

Set the object's id.

Parameters:

Name	Type	Description
id	String

Inherited From:

• ExtensibleData#setId

Returns:

This object, for chaining.

Type

ExtensibleData

---

setIdentifiers(identifiers)

Set the identifiers

Parameters:

Name	Type	Description
identifiers	Object | Identifiers

Inherited From:

• Subject#setIdentifiers

Returns:

This instance

Type

Subject

---

setLang(lang)

Set the language identifier.

Parameters:

Name	Type	Description
lang	String

Inherited From:

• Conclusion#setLang

Returns:

This instance.

Type

Conclusion

---

setLinks(links)

Set the links

Parameters:

Name	Type	Description
links	Links

Inherited From:

• ExtensibleData#setLinks

Returns:

this

Type

ExtensibleData

---

setMedia(media)

Set the media references

Parameters:

Name	Type	Description
media	Array.<Object> | Array.<SourceReference>

Inherited From:

• Subject#setMedia

---

setNotes(notes)

Set the notes

Parameters:

Name	Type	Description
notes	Array.<Object> | Array.<Note>

Inherited From:

• Conclusion#setNotes

Returns:

This instance

Type

Conclusion

---

setPerson1(person1)

Set the person1 reference

Parameters:

Name	Type	Description
person1	ResourceReference

Returns:

This instance

Type

Relationship

---

setPerson2(person2)

Set the person1 reference

Parameters:

Name	Type	Description
person2	ResourceReference

Returns:

This instance

Type

Relationship

---

setSortKey(sortKey)

Set the sortKey

Parameters:

Name	Type	Description
sortKey	Boolean

Inherited From:

• Conclusion#setSortKey

Returns:

this

Type

Conclusion

---

setSources(sources)

Set the sources

Parameters:

Name	Type	Description
sources	Array.<Object> | Array.<SourceReference>

Inherited From:

• Conclusion#setSources

Returns:

This instance

Type

Conclusion

---

setType(type)

Set the relationship type

Parameters:

Name	Type	Description
type	String

Returns:

This instance

Type

Relationship

---

toJSON()

Export the object as JSON

Overrides:

• Subject#toJSON

Returns:

JSON object

Type

Object