org.termweb.api.data.entry

Class TermEntry

java.lang.Object

org.termweb.api.data.BaseTermWebObj

org.termweb.api.data.entry.BaseEntry

org.termweb.api.data.entry.TermEntry

All Implemented Interfaces:

Serializable, TermWebObj

public class TermEntry
extends org.termweb.api.data.entry.BaseEntry

Contains information about a term entry in a dictionary.

XML-RPC object structure

Parameter	Type	Value
__objtype	String	'TermEntry'
id	String	TermEntry ID (internal use)
name	String	Term name
termID	String	Term ID value (visible in GUI)
toBeDeleted	Boolean	Set to true if this term should be deleted from the concept
conceptEntryID	String	ID of the concept to which the Term belongs
dictionaryID	String	ID of the dictionary to which the Term belongs
language	String	Iso3 language code for the term
region	String	Code for the term's region
script	String	Code for the term's script
fields	Struct [String->String]	Map of field names to field values (term level fields)

Example:

{
   "__objtype": "TermEntry",
   "id": "437",
   "name": "fish",
   "termID": "80-2",
   "toBeDeleted": false,
   "conceptEntryID": "436",
   "dictionaryID": "312",
   "language": "eng",
   "fields": {
     "Process status": "finalized"
   }
}

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LANGUAGE
static String	TERM_ID

Fields inherited from class org.termweb.api.data.BaseTermWebObj

ERROR_NULL_FIELD, ERROR_REQUIRED_FIELD, NAME

Constructor Summary

Constructors

Constructor and Description
TermEntry() Creates a new term entry.
TermEntry(TermWebID id) Creates a new term entry with specified ID.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
TermWebID	getConceptEntryID() Returns the ID of the concept entry to which this term belongs.
String	getLanguage() Returns the language code for the entry.
String	getRegion() Gets the region value for the term.
String	getScript() Gets the script for the term.
TermWebID	getSourceTermID()
String	getTermID() Returns the termID for the entry.
boolean	isIdentical(TermEntry term)
boolean	isToBeDeleted() Checks if the term entry is marked for deletion.
void	setConceptEntryID(TermWebID conceptEntryID) Sets the ID of the concept entry to which this term belongs.
void	setLanguage(String language) Sets the language code for the entry.
void	setRegion(String region) Sets the region value for the term.
void	setScript(String script) Sets the script for the term.
void	setSourceTermID(TermWebID sourceTermID)
void	setTermID(String termID) Sets the termID for the entry.
void	setToBeDeleted(boolean toBeDeleted) Marks the term entry for deletion.
String	toString()
boolean	validate(Map<String,String> errors) Validates the object to ensure it contains necessary data to be possible to save in the database.

Methods inherited from class org.termweb.api.data.entry.BaseEntry

getAllFieldNames, getDictionaryID, getFieldValue, getFieldValueMap, setDictionaryID, setFieldValue, validateName

Methods inherited from class org.termweb.api.data.BaseTermWebObj

getChangedBy, getChangedOn, getCreatedBy, getCreatedOn, getID, getName, hashCode, hasMetadata, isNew, setMetadata, setName, setNew, validateNotEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TERM_ID

public static final String TERM_ID

Constant Field Value:

"Term ID"

See Also:

Constant Field Values

LANGUAGE

public static final String LANGUAGE

Constant Field Value:

"Language"

See Also:

Constant Field Values

Constructor Detail

TermEntry

public TermEntry()

Creates a new term entry.

TermEntry

public TermEntry(TermWebID id)

Creates a new term entry with specified ID.

Method Detail

getTermID

public String getTermID()

Returns the termID for the entry.

setTermID

public void setTermID(String termID)

Sets the termID for the entry.

getLanguage

public String getLanguage()

Returns the language code for the entry.

setLanguage

public void setLanguage(String language)

Sets the language code for the entry.

getConceptEntryID

public TermWebID getConceptEntryID()

Returns the ID of the concept entry to which this term belongs.

setConceptEntryID

public void setConceptEntryID(TermWebID conceptEntryID)

Sets the ID of the concept entry to which this term belongs.

isToBeDeleted

public boolean isToBeDeleted()

Checks if the term entry is marked for deletion.

Returns:

True if it is to be deleted.

Since:

2.7

setToBeDeleted

public void setToBeDeleted(boolean toBeDeleted)

Marks the term entry for deletion.

Parameters:

toBeDeleted - True if it is to be deleted.

Since:

2.7

getSourceTermID

public TermWebID getSourceTermID()

setSourceTermID

public void setSourceTermID(TermWebID sourceTermID)

getRegion

public String getRegion()

Gets the region value for the term.

Returns:

The region code or null.

Since:

2.10

setRegion

public void setRegion(String region)

Sets the region value for the term.

Parameters:

region - The region code.

Since:

2.10

getScript

public String getScript()

Gets the script for the term.

Returns:

The script code or null.

Since:

2.10

setScript

public void setScript(String script)

Sets the script for the term.

Parameters:

script - The script code.

Since:

2.10

validate

public boolean validate(Map<String,String> errors)

Validates the object to ensure it contains necessary data to be possible to save in the database. Any validation error detected will be stored in the specified map as field name->error description.

Specified by:

validate in interface TermWebObj

Overrides:

validate in class org.termweb.api.data.BaseTermWebObj

Parameters:

errors - A map of validation errors. May be null if cause of errors is not important.

Returns:

True if the object is validating, false if there is one or more errors.

isIdentical

public boolean isIdentical(TermEntry term)

equals

public boolean equals(Object o)

Overrides:

equals in class org.termweb.api.data.BaseTermWebObj

toString

public String toString()

Overrides:

toString in class org.termweb.api.data.BaseTermWebObj