Class: FieldValue

FieldValue


new FieldValue( [json])

Information about the value of a field.
Parameters:
Name Type Argument Description
json Object <optional>
See:

Extends

Methods


addField(field)

Add a field
Parameters:
Name Type Description
field Field
Inherited From:
Returns:
this
Type
ExtensibleData

Add a link
Parameters:
Name Type Description
link Link
Inherited From:
Returns:
this
Type
ExtensibleData

addNote(note)

Add a note
Parameters:
Name Type Description
note Object | Note
Inherited From:
Returns:
This instance
Type
Conclusion

addSource(source)

Add a source
Parameters:
Name Type Description
source SourceReference
Inherited From:
Returns:
This instance
Type
Conclusion

getAnalysis()

Get analysis.
Inherited From:
Returns:
analysis
Type
ResourceReference

getAttribution()

Get the attribution.
Inherited From:
Returns:
Type
Attribution

getConfidence()

Get the confidence.
Inherited From:
Returns:
confidence
Type
String

getFields()

Get the fields
Inherited From:
Returns:
Type
Array.<Field>

getId()

Get the object's id.
Inherited From:
Returns:
Id
Type
String

getLang()

Get the language identifier.
Inherited From:
Returns:
lang
Type
String

Get a link
Parameters:
Name Type Description
rel String
Inherited From:
Returns:
Type
Link

Get the links
Inherited From:
Returns:
Type
Array.<Link>

getNotes()

Get the notes
Inherited From:
Returns:
notes
Type
Array.<Note>

getSortKey()

Get the sortKey
Inherited From:
Returns:
sortKey
Type
Boolean

getSources()

Get the sources
Inherited From:
Returns:
Type
Array.<SourceReference>

init(json)

Initialize from JSON
Parameters:
Name Type Description
json Object
Inherited From:
Returns:
this
Type
Conclusion

setAnalysis(analysis)

Set the analysis
Parameters:
Name Type Description
analysis Object | ResourceReference
Inherited From:
Returns:
This instance
Type
Conclusion

setAttribution(attribution)

Set the attribution
Parameters:
Name Type Description
attribution Object | Attribution
Inherited From:
Returns:
This instance
Type
Conclusion

setConfidence(confidence)

Set the confidence.
Parameters:
Name Type Description
confidence String
Inherited From:
Returns:
This instance
Type
Conclusion

setFields(fields)

Set the fields
Parameters:
Name Type Description
fields Array.<Field>
Inherited From:
Returns:
this
Type
ExtensibleData

setId(id)

Set the object's id.
Parameters:
Name Type Description
id String
Inherited From:
Returns:
This object, for chaining.
Type
ExtensibleData

setLang(lang)

Set the language identifier.
Parameters:
Name Type Description
lang String
Inherited From:
Returns:
This instance.
Type
Conclusion

Set the links
Parameters:
Name Type Description
links Links
Inherited From:
Returns:
this
Type
ExtensibleData

setNotes(notes)

Set the notes
Parameters:
Name Type Description
notes Array.<Object> | Array.<Note>
Inherited From:
Returns:
This instance
Type
Conclusion

setSortKey(sortKey)

Set the sortKey
Parameters:
Name Type Description
sortKey Boolean
Inherited From:
Returns:
this
Type
Conclusion

setSources(sources)

Set the sources
Parameters:
Name Type Description
sources Array.<Object> | Array.<SourceReference>
Inherited From:
Returns:
This instance
Type
Conclusion

toJSON()

Export the object as JSON
Inherited From:
Returns:
JSON object
Type
Object