com.hp.hpl.mesa.rdf.jena.model
Interface Seq

All Superinterfaces:
Container, RDFNode, Resource
All Known Implementing Classes:
EnhSeq, SeqImpl

public interface Seq
extends Container

RDF Sequence container.

This interface defines methods for accessing RDF Sequence resources. These methods operate on the RDF statements contained in a model. The Sequence implementation may cache state from the underlying model, so objects should not be added to or removed from the Sequence by directly manipulating its properties, whilst the Sequence is being accessed through this interface.

When a member is deleted from a sequence using this interface, or an iterator returned through this interface, all the other members with higher ordinals are renumbered to one below what they previously were.

This interface provides methods supporting typed literals. This means that methods are provided which will translate a built in type, or an object to an RDF Literal. This translation is done by invoking the toString() method of the object, or its built in equivalent. The reverse translation is also supported. This is built in for built in types. Factory objects, provided by the application, are used for application objects.

This interface provides methods for supporting enhanced resources. An enhanced resource is a resource to which the application has added behaviour. RDF containers are examples of enhanced resources built in to this package. Enhanced resources are supported by encapsulating a resource created by an implementation in another class which adds the extra behaviour. Factory objects are used to construct such enhanced resources.

Version:
Release='$Name: $' Revision='$Revision: 1.1 $' Date='$Date: 2001/01/05 14:16:44 $'
Author:
bwm

Method Summary
 Seq add(int index, boolean o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, char o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, double o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, float o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, long o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, java.lang.Object o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, RDFNode o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, java.lang.String o)
          Insert a new member into the sequence at the specified position.
 Seq add(int index, java.lang.String o, java.lang.String l)
          Insert a new member into the sequence at the specified position.
 Alt getAlt(int index)
          Get the member at a given index.
 Bag getBag(int index)
          Get the member at a given index.
 boolean getBoolean(int index)
          Get the member at a given index.
 byte getByte(int index)
          Get the member at a given index.
 char getChar(int index)
          Get the member at a given index.
 double getDouble(int index)
          Get the member at a given index.
 float getFloat(int index)
          Get the member at a given index.
 int getInt(int index)
          Get the member at a given index.
 java.lang.String getLanguage(int index)
          Get the language of the member at a given index.
 Literal getLiteral(int index)
          Get the member at a given.
 long getLong(int index)
          Get the member at a given index.
 RDFNode getObject(int index)
          Get the member at a given index.
 java.lang.Object getObject(int index, ObjectF f)
          Get the member at a given index
 Resource getResource(int index)
          Get the member at a given index.
 Resource getResource(int index, ResourceF f)
          Get the member at a given index.
 Seq getSeq(int index)
          Get the member at a given index.
 short getShort(int index)
          Get the member at a given index.
 java.lang.String getString(int index)
          Get the member at a given index.
 int indexOf(boolean o)
          Return the index of a given member of the sequence.
 int indexOf(char o)
          Return the index of a given member of the sequence.
 int indexOf(double o)
          Return the index of a given member of the sequence.
 int indexOf(float o)
          Return the index of a given member of the sequence.
 int indexOf(long o)
          Return the index of a given member of the sequence.
 int indexOf(java.lang.Object o)
          Return the index of a given member of the sequence.
 int indexOf(RDFNode o)
          Return the index of a given member of the sequence.
 int indexOf(java.lang.String o)
          Return the index of a given member of the sequence.
 int indexOf(java.lang.String o, java.lang.String l)
          Return the index of a given member of the sequence.
 Seq remove(int index)
          Remove the member at the specified index.
 Seq set(int index, boolean o)
          Set the value at a given index in the sequence.
 Seq set(int index, char o)
          Set the value at a given index in the sequence.
 Seq set(int index, double o)
          Set the value at a given index in the sequence.
 Seq set(int index, float o)
          Set the value at a given index in the sequence.
 Seq set(int index, long o)
          Set the value at a given index in the sequence.
 Seq set(int index, java.lang.Object o)
          Set the value at a given index in the sequence.
 Seq set(int index, RDFNode o)
          Set the value at a given index in the sequence.
 Seq set(int index, java.lang.String o)
          Set the value at a given index in the sequence.
 Seq set(int index, java.lang.String o, java.lang.String l)
          Set the value at a given index in the sequence.
 
Methods inherited from interface com.hp.hpl.mesa.rdf.jena.model.Container
add, add, add, add, add, add, add, add, add, contains, contains, contains, contains, contains, contains, contains, contains, contains, iterator, remove, size
 
Methods inherited from interface com.hp.hpl.mesa.rdf.jena.model.Resource
abort, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, begin, commit, equals, getId, getLocalName, getModel, getNameSpace, getProperty, getURI, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, isAnon, listProperties, listProperties, removeProperties, toString
 

Method Detail

add

public Seq add(int index,
               RDFNode o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               boolean o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               long o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               char o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               float o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               double o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               java.lang.String o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               java.lang.String o,
               java.lang.String l)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
l - the langauge of the value added
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

add

public Seq add(int index,
               java.lang.Object o)
        throws RDFException
Insert a new member into the sequence at the specified position.

The existing member at that position, and all others with higher indexes, have their index increased by one.

Parameters:
index - The index of the new member,
o - The member to be added.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

getBoolean

public boolean getBoolean(int index)
                   throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getByte

public byte getByte(int index)
             throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getShort

public short getShort(int index)
               throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getInt

public int getInt(int index)
           throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getLong

public long getLong(int index)
             throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getChar

public char getChar(int index)
             throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getFloat

public float getFloat(int index)
               throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getDouble

public double getDouble(int index)
                 throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getString

public java.lang.String getString(int index)
                           throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getLanguage

public java.lang.String getLanguage(int index)
                             throws RDFException
Get the language of the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getObject

public java.lang.Object getObject(int index,
                                  ObjectF f)
                           throws RDFException
Get the member at a given index

The supplied factory object is used to created the object return.

Parameters:
index - The index of the required member.
f - A factory object used to create the returned object.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getResource

public Resource getResource(int index,
                            ResourceF f)
                     throws RDFException
Get the member at a given index.

The supplied factory object is used to create the returned object.

Parameters:
index - The index of the required member.
f - The factory object used to create the returned object.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getLiteral

public Literal getLiteral(int index)
                   throws RDFException
Get the member at a given.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getResource

public Resource getResource(int index)
                     throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getObject

public RDFNode getObject(int index)
                  throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getBag

public Bag getBag(int index)
           throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getAlt

public Alt getAlt(int index)
           throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

getSeq

public Seq getSeq(int index)
           throws RDFException
Get the member at a given index.
Parameters:
index - The index of the required member.
Returns:
The member at the given index.
Throws:
RDFException - Generic RDF exception.

remove

public Seq remove(int index)
           throws RDFException
Remove the member at the specified index.

All other members with a higher index will have their index reduced by one.

Parameters:
index - The index of the member to be removed.
Returns:
this object to enable cascading of method calls.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(RDFNode o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(boolean o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(long o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(char o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(float o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(double o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(java.lang.String o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(java.lang.String o,
                   java.lang.String l)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
l - the language of the member sought
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

indexOf

public int indexOf(java.lang.Object o)
            throws RDFException
Return the index of a given member of the sequence.

If more the the same value appears more than once in the sequence, it is undefined which of the indexes will be returned.

If the member is not found in this sequence, a value of 0 is returned.

Parameters:
o - The member sought.
Returns:
an index of the member in this sequence or 0 if the member is not found in this sequence.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               RDFNode o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               boolean o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               long o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               char o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               float o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               double o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               java.lang.String o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               java.lang.String o,
               java.lang.String l)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
l - The language of the value set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.

set

public Seq set(int index,
               java.lang.Object o)
        throws RDFException
Set the value at a given index in the sequence.

If the index is not in the range 1 to the size of the sequence, then an RDFException is raised.

Parameters:
index - The index whose member is to be set.
o - The value to be set.
Returns:
this object to enable cascading method calls.
Throws:
RDFException - Generic RDF exception.


Copyright 2001 Hewlett-Packard. All Rights Reserved.