com.hp.hpl.jena.rdf.model.Container Maven / Gradle / Ivy
Show all versions of jena Show documentation
/*
* (c) Copyright 2000, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Hewlett-Packard Development Company, LP
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Container.java
*
* Created on 26 July 2000, 07:49
*/
package com.hp.hpl.jena.rdf.model;
/** An RDF Container.
*
* This interface defines methods for accessing RDF container resources.
* These methods operate on the RDF statements contained in a model. The
* container implementation may cache state from the underlying model, so
* objects should not be added to or removed from the container by directly
* manipulating its properties, whilst the container is being
* accessed through this interface.
*
* When a member is deleted from a container using this interface, or an
* iterator returned through this interface, all the other members with
* higher ordinals are renumbered using an algorithm which may depend on the
* type of the container.
*
* 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.
* @author bwm
* @version Release='$Name: $' Revision='$Revision: 1.1 $' Date='$Date: 2009/06/29 08:55:38 $'
*/
public interface Container extends Resource {
public boolean isAlt();
public boolean isSeq();
public boolean isBag();
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(RDFNode o);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(boolean o);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(long o);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(char o);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(float o);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(double o);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(String o);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @param l The language of the string to be added
* @return this object so that calls may be cascaded.
*/
public Container add(String o, String l);
/** Add a new value to a container.
*
* The size of the container is extended by 1 and the new value is added as
* the last element of the container.
* @param o The value to be added.
* @return this object so that calls may be cascaded.
*/
public Container add(Object o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(RDFNode o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(boolean o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(long o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(char o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(float o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(double o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(String o);
/** Determine whether the container contains a value
* @param o the value being tested for
* @param l the language of the string tested
* @return true if and only if the container contains o
*/
public boolean contains(String o, String l);
/** Determine whether the container contains a value
* @param o the value being tested for
* @return true if and only if the container contains o
*/
public boolean contains(Object o);
/** Remove a value from the container.
*
* The predicate of the statement s identifies the
* ordinal of the value to be removed. Once removed, the values in the
* container with a higher ordinal value are renumbered. The renumbering
* algorithm depends on the type of container.
* @param s The statement to be removed from the model.
* @return this container to enable cascading calls.
*/
public Container remove(Statement s);
/** Return an iterator over the values.
*
*
Note the interator returned is not a standard java.util.iterator.
* It has a close method which SHOULD be called if the
* application has not completed the iteration, but no longer requires
* the iterator. This will enable the freeing of resources in, for
* example, implementations which store their models in a database.
.
* @return Return an iterator over the values.
*/
public NodeIterator iterator();
/** return the number values in the container.
* @return the number of values int the container.
*/
public int size();
}