no.uio.edd.model.geo
Class GeoModelPlace

java.lang.Object
  extended by no.uio.edd.model.geo.GeoModelPlace
All Implemented Interfaces:
GeoModelLinkable, GeoModelLocation

public class GeoModelPlace
extends java.lang.Object
implements GeoModelLinkable, GeoModelLocation


Constructor Summary
GeoModelPlace(GeoModelPlaceReg inGeoModelPlaceReg, org.w3c.dom.Element xmlFragment)
           
 
Method Summary
 boolean addCorefBacklink(java.lang.String corefId)
          Add a link to the list of objects corefering to this.
 java.lang.String asGML()
          My geographical info presented as a Geographical Markup Language fragment.
 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[][] getCorefInfo()
          Return an array with one or more String arrays with the following information for this place: Place ID, the place name, the text of the whole paragraph of the register record.
 java.lang.String getCoreHtml()
           
 java.lang.String getFirstPlaceName()
           
 java.lang.String getGeographicalDescription()
          Get the geographical description for the place connected to this object.
 java.lang.String getGeoInfo()
          My geographical info presented as a "rdf" including an identifier for myself.
 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()
           
 java.lang.String getTextContent()
           
 java.lang.String getXmlFragment()
           
 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.
 void setGeographicalDescription(java.lang.String description)
          Set a geographical description for the place connected to this object.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GeoModelPlace

GeoModelPlace(GeoModelPlaceReg inGeoModelPlaceReg,
              org.w3c.dom.Element xmlFragment)
Method Detail

getTextContent

public java.lang.String getTextContent()

getXmlFragment

public java.lang.String getXmlFragment()

getFirstPlaceName

public java.lang.String getFirstPlaceName()
Returns:
The first non-null place name, if any.

addCorefBacklink

public boolean addCorefBacklink(java.lang.String corefId)
Description copied from interface: GeoModelLinkable
Add a link to the list of objects corefering to this.

Specified by:
addCorefBacklink in interface GeoModelLinkable
Parameters:
corefId - The ID of the coref.
Returns:
True on success.

getCorefBacklinkList

public java.lang.String[] getCorefBacklinkList()
Description copied from interface: GeoModelLinkable
Return the list of object IDs corefering to this.

Specified by:
getCorefBacklinkList in interface GeoModelLinkable
Returns:
The list.

removeCorefBacklink

public boolean removeCorefBacklink(java.lang.String corefId)
Description copied from interface: GeoModelLinkable
Remove a link from the list of objects corefering to this.

Specified by:
removeCorefBacklink in interface GeoModelLinkable
Parameters:
corefId - The ID of the coref.
Returns:
True on success.

getCorefId

public java.lang.String getCorefId()
Description copied from interface: GeoModelLinkable
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.

Specified by:
getCorefId in interface GeoModelLinkable
Returns:
The co-reference ID value.

getId

public java.lang.String getId()
Description copied from interface: GeoModelLinkable
Find the global ID value for this object.

Specified by:
getId in interface GeoModelLinkable
Returns:
The ID value for the linkable object.

getInfoHtml

public java.lang.String getInfoHtml()
Description copied from interface: GeoModelLinkable
Returns a string with a fact sheet on the object in HTML.

Specified by:
getInfoHtml in interface GeoModelLinkable
Returns:
The HTML string.

getCoreHtml

public java.lang.String getCoreHtml()
Returns:
HTML version to be packed in larger HTML file.

getCorefInfo

public java.lang.String[][] getCorefInfo()
Return an array with one or more String arrays with the following information for this place: Place ID, the place name, the text of the whole paragraph of the register record.

Returns:
One or more lines of place information.

removeObject

public boolean removeObject()
Description copied from interface: GeoModelLinkable
Remove this object from the data set.

Specified by:
removeObject in interface GeoModelLinkable
Returns:
True if removed, false if the object is not removable.

setCorefId

public boolean setCorefId(java.lang.String corefId)
Description copied from interface: GeoModelLinkable
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.

Specified by:
setCorefId in interface GeoModelLinkable
Parameters:
corefId - The new co-reference ID value.
Returns:
True on success.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getIdOfPara

public java.lang.String getIdOfPara()
Description copied from interface: GeoModelLinkable
Return the id of the paragraph element this object is connected to, if applicable.

Specified by:
getIdOfPara in interface GeoModelLinkable
Returns:
The ID of the para element. Null if not applicable.

getHtmlTableTr

public java.lang.String getHtmlTableTr()
Description copied from interface: GeoModelLinkable
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).

Specified by:
getHtmlTableTr in interface GeoModelLinkable
Returns:
A tr html fragment.

getGeographicalDescription

public java.lang.String getGeographicalDescription()
Description copied from interface: GeoModelLocation
Get the geographical description for the place connected to this object.

Specified by:
getGeographicalDescription in interface GeoModelLocation
Returns:
The geographical description, possible formalised using pseudo-XML code.

setGeographicalDescription

public void setGeographicalDescription(java.lang.String description)
                                throws GeoModelException
Description copied from interface: GeoModelLocation
Set a geographical description for the place connected to this object.

Specified by:
setGeographicalDescription in interface GeoModelLocation
Parameters:
description - A geographical description, possible formalised using pseudo-XML code.
Throws:
GeoModelException

getGeoInfo

public java.lang.String getGeoInfo()
Description copied from interface: GeoModelLocation
My geographical info presented as a "rdf" including an identifier for myself.

Specified by:
getGeoInfo in interface GeoModelLocation
Returns:
The "rdf" representation of my geographical info. Empty string if no such info.

asGML

public java.lang.String asGML()
Description copied from interface: GeoModelLocation
My geographical info presented as a Geographical Markup Language fragment.

Specified by:
asGML in interface GeoModelLocation
Returns:
The GML fragment.

getName

public java.lang.String getName()
Specified by:
getName in interface GeoModelLinkable
Returns:
A name representing this object. Can be an empty string if it has no name.