no.uio.edd.model.geo
Interface GeoModelLinkable

All Known Implementing Classes:

AddedNode, GeoModelElement, GeoModelLink, GeoModelPerson, GeoModelPlace

public interface GeoModelLinkable

An interface representing all objects that can be at either side of a link pair.

Author:

oeide

Method Summary

boolean	addCorefBacklink(java.lang.String corefId) Add a link to the list of objects corefering to this.
java.lang.String[]	getCorefBacklinkList() Return the list of object IDs corefering to this.
java.lang.String	getCorefId() Any linkable object has a global ID that can be used in co-reference work.
java.lang.String	getHtmlTableTr() Returns a string with a line for a HTML table giving core information about the object: 1) ID. 2) textual representation. 3) main paragraph level connection (if applicable). 4) page (if applicable).
java.lang.String	getId() Find the global ID value for this object.
java.lang.String	getIdOfPara() Return the id of the paragraph element this object is connected to, if applicable.
java.lang.String	getInfoHtml() Returns a string with a fact sheet on the object in HTML.
java.lang.String	getName()
boolean	removeCorefBacklink(java.lang.String corefId) Remove a link from the list of objects corefering to this.
boolean	removeObject() Remove this object from the data set.
boolean	setCorefId(java.lang.String corefId) Any linkable object has a global ID that can be used in co-reference work.

Method Detail

getId

java.lang.String getId()

Find the global ID value for this object.

Returns:

The ID value for the linkable object.

getCorefId

java.lang.String getCorefId()

Any linkable object has a global ID that can be used in co-reference work. In some cases (e.g. person elements) this is the object's own ID. In other cases, such as rs'es, it is the ID of a person or place element, or even another rs or name referring to the same real world object.

Returns:

The co-reference ID value.

setCorefId

boolean setCorefId(java.lang.String corefId)

Any linkable object has a global ID that can be used in co-reference work. In some cases (e.g. person elements) this is the object's own ID. In other cases, such as rs'es, it is the ID of a person or place element, or even another rs or name referring to the same real world object.

Parameters:

corefId - The new co-reference ID value.

Returns:

True on success.

getInfoHtml

java.lang.String getInfoHtml()

Returns a string with a fact sheet on the object in HTML.

Returns:

The HTML string.

getHtmlTableTr

java.lang.String getHtmlTableTr()

Returns a string with a line for a HTML table giving core information about the object: 1) ID. 2) textual representation. 3) main paragraph level connection (if applicable). 4) page (if applicable).

Returns:

A tr html fragment.

removeObject

boolean removeObject()

Remove this object from the data set.

Returns:

True if removed, false if the object is not removable.

addCorefBacklink

boolean addCorefBacklink(java.lang.String corefId)

Add a link to the list of objects corefering to this.

Parameters:

corefId - The ID of the coref.

Returns:

True on success.

removeCorefBacklink

boolean removeCorefBacklink(java.lang.String corefId)

Remove a link from the list of objects corefering to this.

Parameters:

corefId - The ID of the coref.

Returns:

True on success.

getCorefBacklinkList

java.lang.String[] getCorefBacklinkList()

Return the list of object IDs corefering to this.

Returns:

The list.

getIdOfPara

java.lang.String getIdOfPara()

Return the id of the paragraph element this object is connected to, if applicable.

Returns:

The ID of the para element. Null if not applicable.

getName

java.lang.String getName()

Returns:

A name representing this object. Can be an empty string if it has no name.