statement.java

semantic web framework

    
    /** Return the object of the statement.
     *
     * <p>An exception will be thrown if the object is not a Literal.</p>
     * @throws RDFException Generuc RDF exception.
     * @return The object of the statement interpreted as a value of the
     * the specified type.
     */ 
    public String getString() throws RDFException;
    
    /** Return the object of the statement.
     *
     * <p>An exception will be thrown if the object is not a Resource.</p>
     * @return The object of the statement.
     * @throws RDFException Generuc RDF exception.
     */    
    public Resource getResource(ResourceF f) throws RDFException;
    
    /** Return the object of the statement.
     * <p>An exception will be thrown if the object is not a Literal.</p>
     * @return The object of the statement.
     * @param f A factory used to create the returned object.
     * @throws RDFException Generuc RDF exception.
     */    
    public Object getObject(ObjectF f) throws RDFException;
    
    /** Return the object of the statement.
     *
     * <p>An exception will be thrown if the object is not a Resource.</p>
     * @throws RDFException Generuc RDF exception.
     * @return The object of the statement interpreted as a value of the
     * the specified type.
     */    
    public Bag getBag() throws RDFException;
    
    /** Return the object of the statement.
     *
     * <p>An exception will be thrown if the object is not a Resource.</p>
     * @throws RDFException Generuc RDF exception.
     * @return The object of the statement interpreted as a value of the
     * the specified type.
     */    
    public Alt getAlt() throws RDFException;
    
    /** Return the object of the statement.
     *
     * <p>An exception will be thrown if the object is not a Resource.</p>
     * @throws RDFException Generuc RDF exception.
     * @return The object of the statement interpreted as a value of the
     * the specified type.
     */    
    public Seq getSeq() throws RDFException;
    
    /** Return the language of the object of the statement
     *
     * <p>An exception will be thrown if the object is not a Literal.</p>
     * @throws RDFException Generuc RDF exception.
     * @return the language of the object of the statement
     */    
    public String getLanguage() throws RDFException;
    
    /** Return whether the Literal object is well formed XML as would result
     *         from parsing a property element with parseType="Literal"
     *
     * <p>An exception will be thrown if the object is not a Literal.</p>
     * @throws RDFException Generuc RDF exception.
     * @return true if the Literal object is well formed
     */    
    public boolean getWellFormed() throws RDFException;
    
    /** Set the object of the statement.
     * @return this object to enable cascading of method calls.
     * @param o The new value to be set.
     * @throws RDFException Generic RDF exception.
     */
    public Statement set(boolean o) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(long o) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(char o) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(float o) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(double o) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(String o) throws RDFException;  
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @param wellFormed true if o is well formed XML
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(String o, boolean wellFormed) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @param l the language of the String
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(String o, String l) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set.
     * @param l the language of the String
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(String o, String l, boolean wellFormed) 
      throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     * @param o The value to be set
     * @param wellFormed true if o is well formed XML
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(RDFNode o) throws RDFException;
    
    /** Set the object of the statement.
     *  <p>The statement with the old value is removed from the model and 
     *  a new statement with the new value added.</p>
     *  The Object o is converted to a string representation by calling its
     *  <CODE>toString()</CODE> method.
     * @param o The value to be set.
     * @throws RDFException Generic RDF exception.
     * @return this object to enable cascading of method calls.
     */
    public Statement set(Object o) throws RDFException;
    
    /** Remove this statement from its associated model.
     *
     *  <p>The statement with the same subject, predicate and object as this
     *  statement will be removed from the model associated with this
     *  statement.</p>
     * @throws RDFException Generic RDF exception.
     * @return this statement.
     */
    public Statement remove() throws RDFException;
    
/** Determine if this statement is the subject of any statements its associated
 *  model.
 * @param s The statement tested.
 * @throws RDFException Generic RDF Exception
 * @return true if the statement s is the subject of a statement in the model,
             false otherwise
*/ 
    boolean isReified() throws RDFException;

    /**
     * Get the source location information for the statement as set by ARP. 
     * Could be null if no location information is available.
     * @return the Location of the statement in the source, null if none was stored.
     */
    public Location getLocation();

    /**
     * Set the location information for the statement.
     * @param the Location object for the statment.
     */
    void setLocation(Location l);	
}