org.apache.marmotta.kiwi.model.rdf

Class KiWiLiteral

java.lang.Object

org.apache.marmotta.kiwi.model.rdf.KiWiNode

org.apache.marmotta.kiwi.model.rdf.KiWiLiteral

All Implemented Interfaces:

Serializable, org.openrdf.model.Literal, org.openrdf.model.Value

Direct Known Subclasses:

KiWiStringLiteral

public abstract class KiWiLiteral
extends KiWiNode
implements org.openrdf.model.Literal

KiWiLiterals store literal information from the knowledge base. They directly correspond to an RDF literal stored in Sesame. KiWiLiterals are parametrized with the Java type corresponding to the literal content they store. The method getType() returns the KiWiResource representing the RDF type of this literal. This information can e.g. be used to provide appropriate user interfaces. A factory class should be provided that maps between RDF types and Java classes.

Author:

Sebastian Schaffert

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	KiWiLiteral()
protected	KiWiLiteral(Date created)
protected	KiWiLiteral(Locale locale, KiWiUriResource type)
protected	KiWiLiteral(Locale locale, KiWiUriResource type, Date created)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	booleanValue() Returns the boolean value of this literal.
byte	byteValue() Returns the byte value of this literal.
XMLGregorianCalendar	calendarValue() Returns the XMLGregorianCalendar value of this literal.
BigDecimal	decimalValue() Returns the decimal value of this literal.
double	doubleValue() Returns the double value of this literal.
boolean	equals(Object o) A separate equalsContent method for checking whether literals are equal in their content; we cannot override the .equals function with this because it would break the system in cases where the same content is used in different literals.
float	floatValue() Returns the float value of this literal.
abstract String	getContent() Return the content of the literal, using the parametrized Java type
org.openrdf.model.URI	getDatatype() Gets the datatype for this literal.
String	getLabel() Gets the label of this literal.
String	getLanguage() Gets the language tag for this literal, normalized to lower case.
Locale	getLocale() Get the locale representing the language this literal is in; returns null if no language is associated with the literal
KiWiUriResource	getType() Return the RDF/XSD type of this literal.
int	hashCode()
BigInteger	integerValue() Returns the integer value of this literal.
int	intValue() Returns the int value of this literal.
boolean	isAnonymousResource() Return true in case the node is an anonymous resource / BNode (avoids instanceof test)
boolean	isLiteral() Return true in case the node is a literal (avoids instanceof test)
boolean	isUriResource() Return true in case the node is a uri resource (avoids instanceof test)
long	longValue() Returns the long value of this literal.
abstract void	setContent(String content) Set the content of the literal to the content provided as parameter.
void	setLocale(Locale language) Set the language of this literal to the given locale.
void	setType(KiWiUriResource type) Set the RDF/XSD type of this literal.
short	shortValue() Returns the short value of this literal.
String	stringValue() Returns the String-value of a Value object.
String	toString()

Methods inherited from class org.apache.marmotta.kiwi.model.rdf.KiWiNode

getCreated, getId, setCreated, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

KiWiLiteral

public KiWiLiteral()

KiWiLiteral

protected KiWiLiteral(Date created)

KiWiLiteral

protected KiWiLiteral(Locale locale,
           KiWiUriResource type)

KiWiLiteral

protected KiWiLiteral(Locale locale,
           KiWiUriResource type,
           Date created)

Method Detail

getContent

public abstract String getContent()

Return the content of the literal, using the parametrized Java type

Returns:

setContent

public abstract void setContent(String content)

Set the content of the literal to the content provided as parameter.

Parameters:

content -

getLocale

public Locale getLocale()

Get the locale representing the language this literal is in; returns null if no language is associated with the literal

Returns:

setLocale

public void setLocale(Locale language)

Set the language of this literal to the given locale.

Parameters:

language -

getType

public KiWiUriResource getType()

Return the RDF/XSD type of this literal.

Returns:

setType

public void setType(KiWiUriResource type)

Set the RDF/XSD type of this literal.

Parameters:

type -

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

A separate equalsContent method for checking whether literals are equal in their content; we cannot override the .equals function with this because it would break the system in cases where the same content is used in different literals.

Specified by:

equals in interface org.openrdf.model.Literal

Overrides:

equals in class Object

Parameters:

o -

Returns:

hashCode

public int hashCode()

Specified by:

hashCode in interface org.openrdf.model.Literal

Overrides:

hashCode in class Object

isAnonymousResource

public boolean isAnonymousResource()

Description copied from class: KiWiNode

Return true in case the node is an anonymous resource / BNode (avoids instanceof test)

Specified by:

isAnonymousResource in class KiWiNode

Returns:

true if the node is a blank node, false otherwise

isLiteral

public boolean isLiteral()

Description copied from class: KiWiNode

Return true in case the node is a literal (avoids instanceof test)

Specified by:

isLiteral in class KiWiNode

Returns:

true in case the node is a literal, false otherwise

isUriResource

public boolean isUriResource()

Description copied from class: KiWiNode

Return true in case the node is a uri resource (avoids instanceof test)

Specified by:

isUriResource in class KiWiNode

Returns:

true if the node is a URI, false otherwise

booleanValue

public boolean booleanValue()

Returns the boolean value of this literal.

Specified by:

booleanValue in interface org.openrdf.model.Literal

Returns:

The long value of the literal.

Throws:

IllegalArgumentException - If the literal's label cannot be represented by a boolean.

getLabel

public String getLabel()

Gets the label of this literal.

Specified by:

getLabel in interface org.openrdf.model.Literal

Returns:

The literal's label.

getLanguage

public String getLanguage()

Gets the language tag for this literal, normalized to lower case.

Specified by:

getLanguage in interface org.openrdf.model.Literal

Returns:

The language tag for this literal, or null if it doesn't have one.

getDatatype

public org.openrdf.model.URI getDatatype()

Gets the datatype for this literal.

Specified by:

getDatatype in interface org.openrdf.model.Literal

Returns:

The datatype for this literal, or null if it doesn't have one.

byteValue

public byte byteValue()

Returns the byte value of this literal.

Specified by:

byteValue in interface org.openrdf.model.Literal

Returns:

The byte value of the literal.

Throws:

NumberFormatException - If the literal cannot be represented by a byte.

shortValue

public short shortValue()

Returns the short value of this literal.

Specified by:

shortValue in interface org.openrdf.model.Literal

Returns:

The short value of the literal.

Throws:

NumberFormatException - If the literal's label cannot be represented by a short.

intValue

public int intValue()

Returns the int value of this literal.

Specified by:

intValue in interface org.openrdf.model.Literal

Returns:

The int value of the literal.

Throws:

NumberFormatException - If the literal's label cannot be represented by a int.

longValue

public long longValue()

Returns the long value of this literal.

Specified by:

longValue in interface org.openrdf.model.Literal

Returns:

The long value of the literal.

Throws:

NumberFormatException - If the literal's label cannot be represented by to a long.

integerValue

public BigInteger integerValue()

Returns the integer value of this literal.

Specified by:

integerValue in interface org.openrdf.model.Literal

Returns:

The integer value of the literal.

Throws:

NumberFormatException - If the literal's label is not a valid integer.

decimalValue

public BigDecimal decimalValue()

Returns the decimal value of this literal.

Specified by:

decimalValue in interface org.openrdf.model.Literal

Returns:

The decimal value of the literal.

Throws:

NumberFormatException - If the literal's label is not a valid decimal.

floatValue

public float floatValue()

Returns the float value of this literal.

Specified by:

floatValue in interface org.openrdf.model.Literal

Returns:

The float value of the literal.

Throws:

NumberFormatException - If the literal's label cannot be represented by a float.

doubleValue

public double doubleValue()

Returns the double value of this literal.

Specified by:

doubleValue in interface org.openrdf.model.Literal

Returns:

The double value of the literal.

Throws:

NumberFormatException - If the literal's label cannot be represented by a double.

calendarValue

public XMLGregorianCalendar calendarValue()

Returns the XMLGregorianCalendar value of this literal. A calendar representation can be given for literals whose label conforms to the syntax of the following XML Schema datatypes: dateTime, time, date, gYearMonth, gMonthDay, gYear, gMonth or gDay.

Specified by:

calendarValue in interface org.openrdf.model.Literal

Returns:

The calendar value of the literal.

Throws:

IllegalArgumentException - If the literal cannot be represented by a XMLGregorianCalendar.

stringValue

public String stringValue()

Returns the String-value of a Value object. This returns either a Literal's label, a URI's URI or a BNode's ID.

Specified by:

stringValue in interface org.openrdf.model.Value