A B C D E F G H I J L M N O P R S T U V W X Y Z

A

accessHandle() - Method in class org.ispheres.shared.process.ProcessHandle

This function is used by implementing subclasses to access the process handle and set when the handle was last accessed.

add(int, MetadataObject, DigitalObject) - Method in class org.ispheres.client.ISphereClient

Add the metadata and digital object to the local repository.

add(MetadataObject) - Method in class org.ispheres.server.connectors.csvmetadata.CSVMetadataConnector

Adds a new Metadata record to the local repository.

add(DigitalObject) - Method in class org.ispheres.server.connectors.DigitalObjectConnector

Adds a new digital object to the local repository.

add(DigitalObject) - Method in class org.ispheres.server.connectors.FileObjectConnector

Adds a new digital object to the local repository.

add(MetadataObject) - Method in class org.ispheres.server.connectors.MetadataConnector

Adds a new Metadata record to the local repository.

add(MetadataObject) - Method in class org.ispheres.server.connectors.MySQLJoinMetadataConnector

Adds a new Metadata record to the local repository.

add(MetadataObject) - Method in class org.ispheres.server.connectors.MySQLMetadataConnector

Adds a new Metadata record to the local repository.

add(DigitalObject) - Method in class org.ispheres.server.connectors.MySQLObjectConnector

Adds a new digital object to the local repository.

add(MetadataObject, DigitalObject) - Method in class org.ispheres.server.core.Collection

create a new record from the MetadataObject and the ISphereObject and add it to the collection.

add(int, MetadataObject, DigitalObject) - Method in class org.ispheres.server.core.ISphere

Add the metadata and digital object to the local repository.

Add - Class in org.ispheres.server.core.process

This process is used to add a record into the iSphere.

Add(int, Collection, MetadataObject, DigitalObject) - Constructor for class org.ispheres.server.core.process.Add

Adds the metadata and digital object to the local repository.

add(MetadataObject, DigitalObject) - Method in class org.ispheres.server.core.SimpleRepositoryModel

This function adds a new record to the simple repository model.

add(int, MetadataObject, DigitalObject) - Method in interface org.ispheres.shared.core.ISpherePublicInterface

Add the metadata and digital object to the local repository.

addAllowedScheme(Scheme) - Method in class org.ispheres.shared.core.Element

Adds an allowed scheme to this element which can then be used when entering data for this metadata element.

addCollection(int, MetadataObject) - Method in class org.ispheres.client.AuthorityISphereClient

Registers a collection that is contained within an iSphere.

addISphere(MetadataObject) - Method in class org.ispheres.client.AuthorityISphereClient

Does the registration of an iSphere at the specified hostname and adds the information to the iSphere that is the authority server iSphere.

addParameter(String, Class) - Method in class org.ispheres.shared.transforms.TransformInterface

Adds a parameter to the list of parameters required by the transform.

addProcessHandle(int, ProcessHandle) - Method in class org.ispheres.server.core.ThreadPool

Add the ProcessHandle to the Thread Pool.

addServlet(String, String, String) - Static method in class org.ispheres.server.main.ISphereHttpServer

Adds a new Servlet to the HTTP Server.

addSRI(String) - Method in class org.ispheres.server.core.SRI

Adds a new mapping to the simple repository index.

addToIndex(int, MetadataObject, boolean) - Method in class org.ispheres.server.indexing.Indexer

Adds the specified MetadataObject to the index using the specified Simple Repository Index to identify it.

addToRepository(String[]) - Method in class org.ispheres.server.connectors.csvmetadata.CSVDocumentProcessor

Tries to add the specified line to the CSV metadata source file and returns the line number at which the object was stored.

ALLOWED_ONCE - Static variable in class org.ispheres.shared.core.Element

Used for the allowed amount of instances value when only one instance of an element may be used.

ALLOWED_ONCE_REQUIRED - Static variable in class org.ispheres.shared.core.Element

Used for the allowed amount of instances value when only one element may be used and that one is required.

ALLOWED_REQUIRED - Static variable in class org.ispheres.shared.core.Element

Used for the allowed amount of instances value when multiple instances may be used, but at least one must be specified.

ALLOWED_UNLIMITED - Static variable in class org.ispheres.shared.core.Element

Used for the allowed amount of instances value when unlimited instances of an element can be used.

AuthorisationException - Exception in org.ispheres.shared.core

This is a Exception that is typically thrown when a user does not have authorisation for a task.

AuthorisationException(String) - Constructor for exception org.ispheres.shared.core.AuthorisationException

Constructor with a description.

AuthorisationException(String, Throwable) - Constructor for exception org.ispheres.shared.core.AuthorisationException

constructor with description and throwable argument.

AuthorityISphereClient - Class in org.ispheres.client

A proxy class for accessing a remote AuthorityISphere.

AuthorityISphereClient(URL) - Constructor for class org.ispheres.client.AuthorityISphereClient

Creates a AuthorityISphereClient that communicates with an AuthorityiSphere that is running on the machine identified by the specified host.

B

BoundingBox - Class in org.ispheres.shared.objects

BoundingBox Used to only just encompass a piece of geometry.

BoundingBox(Point, Point) - Constructor for class org.ispheres.shared.objects.BoundingBox

BoundingBox Constructor.

bufferResults(String, int, int, boolean) - Method in class org.ispheres.server.core.process.SearchLocalCollection

Call back function - implementing searches need to overide this function.

bufferResults(String, int, int, boolean) - Method in class org.ispheres.server.core.process.SearchRemoteCollection

Call back function - implementing searches need to overide this function.

bufferResults(String, int, int, boolean) - Method in class org.ispheres.shared.process.Search

Call back function - implementing searches need to overide this function.

C

CacheException - Exception in org.ispheres.server.core

An exception which is thrown by a cache.

CacheException(String) - Constructor for exception org.ispheres.server.core.CacheException

Constructor taking a description.

CacheException(String, Throwable) - Constructor for exception org.ispheres.server.core.CacheException

Constructor taking a description and a cause.

checkConsistancy(Schema) - Method in class org.ispheres.shared.objects.MetadataObject

Checks the consistence of the metadata object against the specified metadata schema.

clearAllowedSchemes() - Method in class org.ispheres.shared.core.Element

Clears the list of allowed scheme and re-adds the default scheme to be used for this element.

ClipTransform - Class in org.ispheres.server.transforms

This transform takes a small portion of an Image and returns that as a new image.

ClipTransform(Image, int, int, int, int) - Constructor for class org.ispheres.server.transforms.ClipTransform

Creates a new ClipTransform using the specified source Image and the specified x and y coordinates to specify the clip to get.

clone() - Method in class org.ispheres.shared.objects.BoundingBox

clone() - Method in class org.ispheres.shared.objects.MetadataObject

clone() - Method in class org.ispheres.shared.objects.Point

clone() - Method in class org.ispheres.shared.objects.Polygon

clone() - Method in class org.ispheres.shared.objects.PolyLine

clone() - Method in class org.ispheres.shared.objects.Shape

clone() - Method in class org.ispheres.shared.objects.ShapeElement

close() - Method in class org.ispheres.client.ProcessClient

This function closes the process performing the search on the parent iSphere.

close() - Method in class org.ispheres.client.SearchClient

This function closes the process performing the search on the parent iSphere.

close() - Method in class org.ispheres.server.core.LogFile

Close the LogFile, saving the changes.

close() - Method in class org.ispheres.shared.process.ProcessHandle

This function is used by nice clients to indicate that they have finished with the process and that it can be removed from the system.

close() - Method in interface org.ispheres.shared.process.ProcessPublicInterface

This function is used to close the process on the parent iSphere.

close() - Method in interface org.ispheres.shared.process.SearchPublicInterface

This function is used by nice clients to indicate to the iSphere that they have finished with the search and that it can be removed from the system.

Collection - Class in org.ispheres.server.core

A Collection is an iSphere representation of a group of objects which are similar.

Collection(File, File, int, MetadataObject) - Constructor for class org.ispheres.server.core.Collection

Creates an empty collection.

COLLECTION_COLLECTION - Static variable in class org.ispheres.shared.core.Configuration

The id of the iSphere on the authority server that holds registered collections.

compareTo(Object) - Method in class org.ispheres.shared.core.CrosswalkElement

Compares this Crosswalk to another Crosswalk object.

complete() - Method in class org.ispheres.shared.process.ProcessHandle

This is used to flag a ProcessHandle as being completed.

CompoundTransform - Class in org.ispheres.server.transforms

A special transform that combines several transforms together and performs them in sequential order and returns the resulting object.

CompoundTransform(DigitalObject, TransformInterface[]) - Constructor for class org.ispheres.server.transforms.CompoundTransform

Creates a new CompoundTransform that will perform the specified list of transforms with their associated parameters on the specified source object.

CompoundTransform(DigitalObject, TransformInterface) - Constructor for class org.ispheres.server.transforms.CompoundTransform

Creates a new CompoundTransform that will perform the specified transforms with the associated parameters on the specified source object.

Configuration - Class in org.ispheres.shared.core

The Configuration class holds the various configuration details we need to run iSpheres.

ConfigurationFileProcessor - Class in org.ispheres.server.connectors.csvmetadata

SAX Parser for configuration file.

ConfigurationFileProcessor(InputSource, Schema) - Constructor for class org.ispheres.server.connectors.csvmetadata.ConfigurationFileProcessor

Constructor fo Configuration File Processor.

ConnectorException - Exception in org.ispheres.server.connectors

An class encapsulating exceptions that are being generated by connectors while performing operations on the local repository.

ConnectorException(String) - Constructor for exception org.ispheres.server.connectors.ConnectorException

Constructs a new ConnectorException with the specified message that describes the exception that has occured.

ConnectorException(Throwable) - Constructor for exception org.ispheres.server.connectors.ConnectorException

Constructs a new ConnectorException with the specified throwable that caused the exception to occur.

ConnectorException(String, Throwable) - Constructor for exception org.ispheres.server.connectors.ConnectorException

Constructs a new ConnectorException with the specified message describing the exception that occured and a Throwable that caused the exception.

consistancyCheck() - Method in class org.ispheres.client.ISphereClient

Checks the consistancy of the ISphere.

consistancyCheck(LogFile) - Method in class org.ispheres.server.core.Collection

Check if the Collection passes the consistancy check.

consistancyCheck() - Method in class org.ispheres.server.core.ISphere

Checks the consistancy of the ISphere.

consistancyCheck() - Method in interface org.ispheres.shared.core.ISphereAdminInterface

Checks the consistancy of the ISphere.

consistencyCheck() - Method in class org.ispheres.server.core.SimpleRepositoryModel

A consistency check does not assume that location metadata object is correct.

containsAllowedScheme(int) - Method in class org.ispheres.shared.core.Element

Checks whether the specified scheme already exists in the list of allowed schemes.

Crosswalk - Class in org.ispheres.shared.core

Describes a collection of crosswalk elements which contain the actual mapping from the source element to the destination element.

Crosswalk(File, Schema, Schema) - Constructor for class org.ispheres.shared.core.Crosswalk

Creates a Crosswalk which is able to perform a crosswalk from the specified source schema to the specified destination schema using the specified crosswalk file.

CrosswalkElement - Class in org.ispheres.shared.core

Describes a crosswalk from an element in one schema to some other element in another schema.

CrosswalkElement(int, int) - Constructor for class org.ispheres.shared.core.CrosswalkElement

Creates a new crosswalk object which maps the contents of the specified source element id to the specified destination element id.

CSVDocumentProcessor - Class in org.ispheres.server.connectors.csvmetadata

Processing the CSV document and construct the meta data repository.

CSVDocumentProcessor(File) - Constructor for class org.ispheres.server.connectors.csvmetadata.CSVDocumentProcessor

Processing the CSV document and construct the repository.

CSVMetadataConnector - Class in org.ispheres.server.connectors.csvmetadata

A connector that allows for reading metadata from a Comma Seperated Values file.

CSVMetadataConnector(File, File) - Constructor for class org.ispheres.server.connectors.csvmetadata.CSVMetadataConnector

Default constructor for the CvsMetadataConnector.

D

DatabaseRecord - Class in org.ispheres.shared.objects

The DatabaseRecord class is an class which should be used by a database connector and contains the columns and a values of a single record within the database.

DatabaseRecord() - Constructor for class org.ispheres.shared.objects.DatabaseRecord

Creates a new database record, fill in the instance variables using populate(byte[]).

DatabaseRecord(Map<String, Object>) - Constructor for class org.ispheres.shared.objects.DatabaseRecord

Creates a new database record from the supplied new values.

DATETIME_FORMAT - Static variable in class org.ispheres.server.core.ISphere

The date and time format that is used by the iSphere application.

DEFAULT_CFG - Static variable in class org.ispheres.server.main.ISphereHttpServer

The default configuration file that iSphere utalises.

DEFAULT_IP - Static variable in class org.ispheres.server.main.ISphereHttpServer

The default ip on which the iSphere server will run.

DEFAULT_PORT - Static variable in class org.ispheres.server.main.ISphereHttpServer

The default port on which the iSpheres application runs.

deserialise(byte[]) - Method in interface org.ispheres.shared.streams.ISpheresStream

deserialise the object with the data in theInputBytes.

deserialise(byte[]) - Method in class org.ispheres.shared.streams.JPGImageStream

deserialises a Digital Object.

deserialise(byte[]) - Method in class org.ispheres.shared.streams.PNGImageStream

deserialises a Digital Object.

deserialise(byte[]) - Method in class org.ispheres.shared.streams.XMLDatabaseRecordStream

deserialise the object with the data in theInputBytes.

destroy() - Method in class org.ispheres.server.main.ISphereServlet

Destroys the ISphere servlet - Called when the ISphere servlet is taken out of service.

destruct() - Method in class org.ispheres.server.core.SRI

SRI descructor.

DigitalObject - Class in org.ispheres.shared.objects

The abstract ISphere object class from which all other classes in the object hierarchy inherit.

DigitalObject(ArrayList<ISpheresStream>) - Constructor for class org.ispheres.shared.objects.DigitalObject

Default constructor.

DigitalObjectConnector - Class in org.ispheres.server.connectors

An abstract class which forms the base of any implementation DigitalObjectConnector.

DigitalObjectConnector(File, Boolean, Class) - Constructor for class org.ispheres.server.connectors.DigitalObjectConnector

DigitalObjectConnector constructor, intialises required fields.

DigitalObjectException - Exception in org.ispheres.shared.objects

Exception class to encapsulate exceptions that are being generated during the creation or saving of DigitalObjects.

DigitalObjectException(String) - Constructor for exception org.ispheres.shared.objects.DigitalObjectException

Constructs a new DigitalObjectException with the specified detail message.

DigitalObjectException(String, Throwable) - Constructor for exception org.ispheres.shared.objects.DigitalObjectException

Constructs a new DigitalObjectException with the specified detail message and the specified Throwable that caused this exception.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.ispheres.server.main.ISphereServlet

This function generates the servlet response to a HTTP get request.

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.ispheres.server.main.ISphereServlet

This function generates the servlet response to a HTTP post request.

doSoapCall(String) - Method in class org.ispheres.client.GenericClient

Convenience method for performing a SOAP call to a method that doesn't take any arguments and doesn't require a SOAP action.

doSoapCall(String, String[], Object[]) - Method in class org.ispheres.client.GenericClient

Convenience method for performing a SOAP call to a particular method with the specified parameter names and parameters without using a SOAPAction.

doSoapCall(String, String[], Class[], Object[]) - Method in class org.ispheres.client.GenericClient

Performs a SOAP call to the specified method on the iSphere for which this GenericProxy was created, using the specified list of parameters, parameter names and types and the specified SOAPAction.

E

editSRI(Integer, String) - Method in class org.ispheres.server.core.SRI

Edits the existing simple repository index.

EID_C_COLLECTION_ID - Static variable in class org.ispheres.shared.core.Configuration

The element id for the collection identifier in the Collection schema.

EID_C_COLLECTION_NAME - Static variable in class org.ispheres.shared.core.Configuration

The element id for the collection name in the Collection schema.

EID_C_ISPHERE_ADDR - Static variable in class org.ispheres.shared.core.Configuration

The identifier of the element in the iSphere schema which contains the iSphere address.

EID_C_ISPHERE_ID - Static variable in class org.ispheres.shared.core.Configuration

The element id for the iSphere identifier in the Collection schema.

EID_F_COLLECTION_ID - Static variable in class org.ispheres.shared.core.Configuration

The element id for the collection identifier in the functional schema.

EID_F_ISPHERE_ADDR - Static variable in class org.ispheres.shared.core.Configuration

The identifier of the element in the functional metadata which contains the isphere address.

EID_F_ISPHERE_ID - Static variable in class org.ispheres.shared.core.Configuration

The identifier of the element in the functional metadata which contains the isphere identifier.

EID_F_SCORE - Static variable in class org.ispheres.shared.core.Configuration

The element identifier of the element holding the metadata score (hit-rate) in the functional metadata schema.

EID_F_SRI - Static variable in class org.ispheres.shared.core.Configuration

The element identifier of the simple repository index in the functional schema.

EID_I_ISPHERE_ADDR - Static variable in class org.ispheres.shared.core.Configuration

The identifier of the element in the iSphere schema which contains the iSphere address.

EID_I_ISPHERE_ID - Static variable in class org.ispheres.shared.core.Configuration

The identifier of the element in the iSphere schema which contains the iSphere identifier.

Element - Class in org.ispheres.shared.core

Describes a certain element within a metadata scheme.

Element(int, String, String, String, Scheme) - Constructor for class org.ispheres.shared.core.Element

Creates a default element with the specified unique identifier and other provided information.

equals(Object) - Method in class org.ispheres.shared.core.CrosswalkElement

Tries to determine whether two Crosswalk objects are equal to each other, which is true when both the source element and destination element id are the same.

equals(Object) - Method in class org.ispheres.shared.core.Element

Checks whether this Element object is equal to the specified Object and returns true when it is.

equals(Object) - Method in class org.ispheres.shared.core.Schema

Checks whether this Schema is equal to another Schema object and returns true when it is.

equals(Object) - Method in class org.ispheres.shared.core.Scheme

Checks whether this Schema object is equal to another object.

equals(DatabaseRecord) - Method in class org.ispheres.shared.objects.DatabaseRecord

Checks whether this DatabaseRecord is equal to the specified DatabaseRecord and returns true when it is.

equals(Image) - Method in class org.ispheres.shared.objects.Image

Whether this object is equal to obj.

equals(MetadataObject) - Method in class org.ispheres.shared.objects.MetadataObject

Compare two instances of MetadataObject.

equals(Point) - Method in class org.ispheres.shared.objects.Point

Use this to compare two points.

equals(Shape) - Method in class org.ispheres.shared.objects.Shape

Use this to compare two shapes.

equals(Object) - Method in class org.ispheres.shared.util.StringArrayWrapper

Properly checks whether two arrays are the same.

error(SAXParseException) - Method in class org.ispheres.shared.core.XMLErrorHandler

SAX call back function for when an error occurs, this method is used for when validity constraint is violated.

execute() - Method in class org.ispheres.server.core.process.Add

This performs the actual process.

execute() - Method in class org.ispheres.server.core.process.GetMetadata

This performs the actual process.

execute() - Method in class org.ispheres.server.core.process.GetObject

This performs the actual process.

execute() - Method in class org.ispheres.server.core.process.GetTransformedObject

This function performs the actual process of fetching a transformed object.

execute() - Method in class org.ispheres.server.core.process.NumSearchCollectionResults

This performs the actual process.

execute() - Method in class org.ispheres.server.core.process.RegisterCollection

Register the Collection with the Authority Server.

execute() - Method in class org.ispheres.server.core.process.RegisterISphere

Register the iSphere with the Authority Server.

execute() - Method in class org.ispheres.server.core.process.Remove

This performs the actual remove process.

execute() - Method in class org.ispheres.server.core.process.SearchCollection

This performs the actual process.

execute() - Method in class org.ispheres.server.core.process.SetMetadata

This performs the actual SetMetadata process.

execute(MetadataObject) - Method in class org.ispheres.shared.core.Crosswalk

Performs the actual crosswalking using the information contained within this class and the specified metadata and returns a copy of the source metadata that is conform to the destination schema.

execute() - Method in class org.ispheres.shared.process.Process

This method should be overridden by implementing classes and should perform the actual process.

extendsThis(Class) - Static method in class org.ispheres.server.transforms.Transform

Checks if the supplied class extends the digital object.

extendsThis(Class) - Static method in class org.ispheres.shared.objects.DigitalObject

Checks if the supplied class extends the digital object.

F

fatalError(SAXParseException) - Method in class org.ispheres.shared.core.XMLErrorHandler

SAX call back function for when a fatal error occurs, this method is used when well-formedness constraint is violated.

FatalException - Exception in org.ispheres.shared.core

Indicates that something really bad has happened and we probably want to terminate the program.

FatalException() - Constructor for exception org.ispheres.shared.core.FatalException

The default constructor with no arguments.

FatalException(String) - Constructor for exception org.ispheres.shared.core.FatalException

A constructor that takes a description.

FatalException(String, Throwable) - Constructor for exception org.ispheres.shared.core.FatalException

A constructor that takes a description and an exception.

fetchLine(int) - Method in class org.ispheres.server.connectors.csvmetadata.CSVDocumentProcessor

Gte the text line of from this associated meta data file through the line number specified.

FileObjectConnector - Class in org.ispheres.server.connectors

An ObjectConnector for reading and writing objects to and from a file system.

FileObjectConnector(File, Boolean, Class) - Constructor for class org.ispheres.server.connectors.FileObjectConnector

Constructor of FileObjectConnector.

flipSide() - Method in class org.ispheres.shared.transforms.TransformInterface

Flips the side from server to client.

G

generateUniqueId(long, String) - Static method in class org.ispheres.server.core.ISphereId

Generate a unique identifier, this is generated from a concatination of the time in milliseconds (POSIX time) and a hash of the local ip address.

GenericClient - Class in org.ispheres.client

Abstract base class for proxy classes that access a remote iSphere.

GenericClient(URL) - Constructor for class org.ispheres.client.GenericClient

Creates a new GenericProxy that will perform SOAP calls on an iSphere at the specified URL.

GenericClient(URL, String) - Constructor for class org.ispheres.client.GenericClient

Creates a new GenericProxy that will perform SOAP calls on an iSphere at the specified URL and uses the specified SOAPAction in the HTTP headers.

get(String) - Method in class org.ispheres.server.connectors.csvmetadata.CSVMetadataConnector

Gets a digital object at the specified location from the local repository.

get(String) - Method in class org.ispheres.server.connectors.DigitalObjectConnector

Gets a digital object at the specified location from the local repository.

get(String) - Method in class org.ispheres.server.connectors.FileObjectConnector

Gets a digital object at the specified location from the local repository.

get(String) - Method in class org.ispheres.server.connectors.MetadataConnector

Fetches metadata at the specified location from the local repository.

get(String) - Method in class org.ispheres.server.connectors.MySQLJoinMetadataConnector

Gets a digital object at the specified location from the local repository.

get(String) - Method in class org.ispheres.server.connectors.MySQLMetadataConnector

Gets a digital object at the specified location from the local repository.

get(String) - Method in class org.ispheres.server.connectors.MySQLObjectConnector

Gets a digital object at the specified location from the local repository.

get(TransformInterface[], int) - Method in class org.ispheres.server.core.TransformedObjectCache

Attempts to get a transformed object from the cache.

get(TransformInterface, int) - Method in class org.ispheres.server.core.TransformedObjectCache

Attempts to get a transformed object from the cache.

get(int) - Method in class org.ispheres.shared.objects.MetadataObject

Returns the value associated with the specified non-functional metadata element.

getAfterValue() - Method in class org.ispheres.shared.core.CrosswalkElement

Gets the value to put in after the actual value that is being crosswalked.

getAll(int) - Method in class org.ispheres.server.core.TransformedObjectCache

Deprecated. This function is used for debugging purposes only and will eventually be removed from this class.

getAllIndices() - Method in class org.ispheres.server.core.SRI

getAllLocations() - Method in class org.ispheres.server.connectors.csvmetadata.CSVDocumentProcessor

Returns a list of all the locations of metadata records that are held within the local repository.

getAllLocations() - Method in class org.ispheres.server.connectors.csvmetadata.CSVMetadataConnector

Returns a list of all the locations of metadata records that are held within the local repository.

getAllLocations() - Method in class org.ispheres.server.connectors.DigitalObjectConnector

Returns a list of all the locations of digital objects that are held within the local repository.

getAllLocations() - Method in class org.ispheres.server.connectors.FileObjectConnector

Returns a list of all the locations of digital objects that are held within the local repository.

getAllLocations() - Method in class org.ispheres.server.connectors.MetadataConnector

Returns a list of all the locations of metadata records that are held within the local repository.

getAllLocations() - Method in class org.ispheres.server.connectors.MySQLJoinMetadataConnector

Returns a list of all the locations of metadata records that are held within the local repository.

getAllLocations() - Method in class org.ispheres.server.connectors.MySQLMetadataConnector

Returns a list of all the locations of metadata records that are held within the local repository.

getAllLocations() - Method in class org.ispheres.server.connectors.MySQLObjectConnector

Returns a list of all the locations of digital objects that are held within the local repository.

getAllObjectLocations(Integer) - Method in class org.ispheres.server.connectors.csvmetadata.CSVDocumentProcessor

Returns a list of all the locations of Digital objects that the metadata in the local repository references.

getAllObjectLocations() - Method in class org.ispheres.server.connectors.csvmetadata.CSVMetadataConnector

Returns a list of all the locations of Digital objects that the metadata in the local repository references.

getAllObjectLocations() - Method in class org.ispheres.server.connectors.MetadataConnector

Returns a list of all the locations of Digital objects that the metadata in the local repository references.

getAllObjectLocations() - Method in class org.ispheres.server.connectors.MySQLJoinMetadataConnector

Returns a list of all the locations of Digital objects that the metadata in the local repository references.

getAllObjectLocations() - Method in class org.ispheres.server.connectors.MySQLMetadataConnector

Returns a list of all the locations of Digital objects that the metadata in the local repository references.

getAllowedAmount() - Method in class org.ispheres.shared.core.Element

Returns the allowed amount of instances that can be created for this element.

getAllowedSchemes() - Method in class org.ispheres.shared.core.Element

Returns the list of allowed schemes for this element.

getArray() - Method in class org.ispheres.shared.util.StringArrayWrapper

Returns the array that is being wrapped.

getAuthorityServerUrl() - Method in class org.ispheres.shared.core.Configuration

Returns the location of the authority server.

getBeforeValue() - Method in class org.ispheres.shared.core.CrosswalkElement

Gets the value to put in before the actual value is being crosswalked.

getBoundingBox() - Method in class org.ispheres.shared.objects.Polygon

getBoundingBox() - Method in class org.ispheres.shared.objects.PolyLine

getCapabilities(int) - Method in class org.ispheres.client.ISphereClient

Returns the list of transforms that can be performed on the objects stored in the specified collection.

getCapabilities(int) - Method in class org.ispheres.server.core.ISphere

Returns the list of transforms that can be performed on the objects stored in the specified collection.

getCapabilities(Class) - Method in class org.ispheres.shared.core.Configuration

Returns the interfaces for the transforms that can be performed on objects of the specified type.

getCapabilities(int) - Method in interface org.ispheres.shared.core.ISpherePublicInterface

Returns the list of transforms that can be performed on the objects stored in the specified collection.

getClassName() - Method in class org.ispheres.shared.core.Scheme

Returns the fully qualified name of a Java class which will provide lookup features for the values entered in a scheme when using the TYPE_LOOKUP type.

getCollection(int) - Method in class org.ispheres.server.core.ISphere

Returns the collection identified by the specified collection identifier.

getCollection() - Method in class org.ispheres.shared.objects.MetadataObject

getCollectionCrosswalk() - Method in class org.ispheres.shared.core.Configuration

Returns a reference to the Crosswalk object that can perform crosswalks on collection metadata to the universal schema zero.

getCollectionMetadata(int) - Method in class org.ispheres.client.ISphereClient

Returns the metadata for the collection with the specified identifier.

getCollectionMetadata() - Method in class org.ispheres.server.core.Collection

Returns the metadata which describes this collection.

getCollectionMetadata(int) - Method in class org.ispheres.server.core.ISphere

Returns the metadata for the collection with the specified identifier.

getCollectionMetadata(int) - Method in interface org.ispheres.shared.core.ISpherePublicInterface

Returns the metadata for the collection with the specified identifier.

getCollections() - Method in class org.ispheres.server.core.ISphere

Returns the list of collections that are registered with this iSphere as a list.

getCollectionSchema() - Method in class org.ispheres.shared.core.Configuration

Returns a reference to the Collection schema specifying the metadata for a collection.

getColorDepth() - Method in class org.ispheres.shared.objects.Image

Returns the color depth which is used by the image, or it throws an IllegalStateException when the image file hasn't been loaded yet, in which case the load method should first be called.

getColumns() - Method in class org.ispheres.shared.objects.DatabaseRecord

Returns a Set of columns which are available within this DatabaseRecord instance.

getConfigurationFile() - Method in class org.ispheres.server.connectors.DigitalObjectConnector

Returns the configuration file that was used to create the DigitalObjectConnector with.

getConfigurationFile() - Method in class org.ispheres.server.connectors.MetadataConnector

Returns the File object that represents the file that was used to create the metadata connector with.

getConfigurationFile() - Static method in class org.ispheres.server.main.ISphereHttpServer

Returns the name of the configuration file that was passed as an argument at the start of the application.

getContentHandler() - Method in class org.ispheres.server.connectors.csvmetadata.ConfigurationFileProcessor

Get the content handler.

getContentHandler() - Method in class org.ispheres.server.connectors.csvmetadata.XMLSAXProcessor

Get the Content Handler.

getContentType() - Method in class org.ispheres.shared.core.Schema

Returns the Content-Type that is used for Schema objects for transfer using SOAP.

getContentType() - Method in class org.ispheres.shared.objects.DigitalObject

getContentType() - Method in interface org.ispheres.shared.streams.ISpheresStream

getContentType() - Method in class org.ispheres.shared.streams.JPGImageStream

getContentType() - Method in class org.ispheres.shared.streams.PNGImageStream

getContentType() - Method in class org.ispheres.shared.streams.XMLDatabaseRecordStream

getCurrentStream() - Method in class org.ispheres.shared.objects.DigitalObject

getData() - Method in class org.ispheres.shared.objects.Image

getDateFormat(Integer) - Method in class org.ispheres.server.connectors.csvmetadata.ConfigurationFileProcessor

Get the simple date format through the record position.

getDecimalPlaces() - Method in class org.ispheres.shared.core.Scheme

Returns the amount of decimal places which can be used when entering data for this scheme.

getDefaultScheme() - Method in class org.ispheres.shared.core.Element

Returns the default scheme to be used for this element.

getDescription() - Method in class org.ispheres.shared.core.Element

Returns the description for this element.

getDescription() - Method in class org.ispheres.shared.core.Scheme

Returns the description for this scheme.

getDescriptionElements() - Method in class org.ispheres.shared.core.Schema

Returns the list of elements that make up the description of a MetadataObject in this schema.

getDestinationElementId() - Method in class org.ispheres.shared.core.CrosswalkElement

Gets the unique identifier of the destination element.

getDestinationSchema() - Method in class org.ispheres.shared.core.Crosswalk

Returns the destination schema used by this crosswalk.

getElapsedTime() - Method in class org.ispheres.shared.process.ProcessHandle

getElementID(Integer) - Method in class org.ispheres.server.connectors.csvmetadata.ConfigurationFileProcessor

Get the element ID through the record position.

getElementId(String) - Method in class org.ispheres.shared.core.Schema

Returns the unique identifier of the element with the specified name.

getElementIds(String[]) - Method in class org.ispheres.shared.core.Schema

Retrieves a list of unique identifiers for the elements with the specified names, or throws a NoSuchElementException when one of the specified elements does not exist.

getElementName(int) - Method in class org.ispheres.shared.core.Schema

Returns the name or tag of the element with the specified unique identifier.

getElements() - Method in class org.ispheres.shared.core.Schema

Returns the mapping of unique identifiers of elements to the actual Element objects.

getEntries() - Method in class org.ispheres.shared.objects.MetadataObject

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.ISphereSerialisableObjectEncoder

Gets an Entry object representing the object that is being serialised.

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.MetadataEntryEncoder

Gets an Entry object representing the object that is being serialised.

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.MetadataObjectEncoder

Gets an Entry object representing the object that is being serialised.

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.ProcessPublicInterfaceEncoder

Gets an Entry object representing the object that is being serialised.

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.ProcessStatusEncoder

Gets an Entry object representing the object that is being serialised.

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.SearchPublicInterfaceEncoder

Gets an Entry object representing the object that is being serialised.

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.TransformInterfaceEncoder

Gets an Entry object representing the object that is being serialised.

getEntry(SoapConfig, Entry, String, Object, Class, ObjectMap, String, String) - Method in class org.ispheres.shared.encoding.TransformInterfaceParameterEncoder

Gets an Entry object representing the object that is being serialised.

getErrorHandler() - Method in class org.ispheres.server.connectors.csvmetadata.XMLSAXProcessor

Provides the default XMLErrorHandler.

getFile() - Method in class org.ispheres.shared.core.Crosswalk

Returns the File object specifying the file that was used to create the crosswalk object from.

getFile() - Method in class org.ispheres.shared.core.Schema

Returns the filename of the file in which the metadata schema is stored.

getFirst() - Method in class org.ispheres.shared.util.Pair

Gets the first object contained within this pair.

getFunctional(int) - Method in class org.ispheres.shared.objects.MetadataObject

Returns the value associated with the specified functional metadata element.

getFunctionalEntries() - Method in class org.ispheres.shared.objects.MetadataObject

getFunctionalMetadataSchema() - Method in class org.ispheres.shared.core.Configuration

Returns a reference to the functional metadata schema specifying the functional metadata.

getFuture(int) - Method in class org.ispheres.server.core.ThreadPool

This function fetches a Future to a process that iSphere is currently performing.

getHandle(int) - Method in class org.ispheres.server.core.ISphere

This returns a handle to a process running within iSpheres.

getHandle() - Method in class org.ispheres.shared.process.ProcessHandle

getHeight() - Method in class org.ispheres.shared.objects.Image

Returns the height of the image, or it throws an IllegalStateException when the image file hasn't been loaded yet, in which case the load method should first be called.

getHttpServerURL() - Static method in class org.ispheres.server.main.ISphereHttpServer

This function returns the URL of the HttpServer.

getIdleTime() - Method in class org.ispheres.shared.process.ProcessHandle

This function returns the time that this process handle has been idle, this is essentially the time since the process handle has been accessed.

getImage() - Method in class org.ispheres.shared.objects.Image

getIndex(String) - Method in class org.ispheres.server.core.SRI

Get the simple repository index of the specified metadata location.

getIndexes() - Method in class org.ispheres.shared.objects.Polygon

getIndexes() - Method in class org.ispheres.shared.objects.PolyLine

getIndexLocation() - Method in class org.ispheres.server.core.SimpleRepositoryModel

Returns the location of the index, so that it can be written back to the configuration file when necessary.

getISphere() - Method in class org.ispheres.shared.objects.MetadataObject

getISphereCrosswalk() - Method in class org.ispheres.shared.core.Configuration

Returns a reference to the iSphere crosswalk specifying how iSphere metadata should be crosswalked.

getISphereMetadata() - Method in class org.ispheres.client.ISphereClient

Returns the metadata object describing the iSphere.

getISphereMetadata() - Method in class org.ispheres.server.core.ISphere

Returns the metadata object describing the iSphere.

getISphereMetadata() - Method in interface org.ispheres.shared.core.ISpherePublicInterface

Returns the metadata object describing the iSphere.

getISpherePool() - Method in class org.ispheres.server.core.ISphere

getISphereSchema() - Method in class org.ispheres.shared.core.Configuration

Returns a reference to the iSphere schema specifying the metadata for an iSphere.

getISphereURL() - Static method in class org.ispheres.server.core.ISphere

Returns the full URL where the iSphere is located.

getLocalSchema(int) - Method in class org.ispheres.client.ISphereClient

Returns the local schema used for a particular collection.

getLocalSchema() - Method in class org.ispheres.server.connectors.MetadataConnector

Returns the metadata schema used by the local repository.

getLocalSchema() - Method in class org.ispheres.server.core.Collection

This function returns the local schema of the collection.

getLocalSchema(int) - Method in class org.ispheres.server.core.ISphere

Returns the local schema used for a particular collection.

getLocalSchema() - Method in class org.ispheres.server.core.SimpleRepositoryModel

Fetches the schema of the local repository.

getLocalSchema(int) - Method in interface org.ispheres.shared.core.ISpherePublicInterface

Returns the local schema used for a particular collection.

getLocation(Integer) - Method in class org.ispheres.server.core.SRI

Get the metadata location for the specified entry in the SRI.

getLocation() - Method in class org.ispheres.server.indexing.Indexer

Returns the location in the file system where the index is being stored so that it can be written back to the configuration file when necesarry.

getMax() - Method in class org.ispheres.shared.objects.BoundingBox

getMaxChars() - Method in class org.ispheres.shared.core.Scheme

Returns the maximum amount of characters that can be used when entering data for this scheme.

getMaxElapsedTime() - Method in class org.ispheres.shared.core.Configuration

getMaxIdleTime() - Method in class org.ispheres.shared.core.Configuration

getMaxValue() - Method in class org.ispheres.shared.core.Scheme

Returns the maximum value which can be used when entering data in this scheme.

getMetadata(int, int, boolean) - Method in class org.ispheres.client.ISphereClient

Retrieve the specified metadata record from the collection.

getMetadata(int, boolean) - Method in class org.ispheres.server.core.Collection

Fetches a metadata object from the collection - the returned metadata object is in the local schema.

getMetadata(int, int, boolean) - Method in class org.ispheres.server.core.ISphere

Retrieve the specified metadata record from the collection.

GetMetadata - Class in org.ispheres.server.core.process

This process can be used to fetch metadata from a collection.

GetMetadata(int, String, Collection, int, boolean) - Constructor for class org.ispheres.server.core.process.GetMetadata

Constructor - This will create a process which will retrieve the specified metadata record from the nominated collection.

getMetadata(int) - Method in class org.ispheres.server.core.SimpleRepositoryModel

Fetches a metadata object from the local repository.

getMetadata(int, int, boolean) - Method in interface org.ispheres.shared.core.ISpherePublicInterface

Retrieve the specified metadata record from the collection.

getMetadataConnector() - Method in class org.ispheres.server.core.SimpleRepositoryModel

Returns the metadata connector that is being used by this simple repository model to read and write metadata.

getMetadataFile() - Method in class org.ispheres.server.connectors.csvmetadata.ConfigurationFileProcessor

Get the metadata file.

getMin() - Method in class org.ispheres.shared.objects.BoundingBox

getMinValue() - Method in class org.ispheres.shared.core.Scheme

Returns the minimum value which can be used when entering data in this scheme.

getName() - Method in class org.ispheres.shared.core.Element

Returns the name or tag for this element.

getName() - Method in class org.ispheres.shared.core.Scheme

Returns the name for this scheme.

getNewObjectInstance() - Method in class org.ispheres.server.connectors.DigitalObjectConnector

Creates a new instance of the DigitalObject stored inside the digital object connector.

getNextProcessHandleIndex() - Method in class org.ispheres.server.core.ThreadPool

This function generates an index for the next available process handle.

getNumberOfParts() - Method in class org.ispheres.shared.objects.Polygon

getNumberOfParts() - Method in class org.ispheres.shared.objects.PolyLine

getNumberOfPoints() - Method in class org.ispheres.shared.objects.Polygon

getNumberOfPoints() - Method in class org.ispheres.shared.objects.PolyLine

getNumCollections() - Method in class org.ispheres.server.core.ISphere

This function returns the number of collections held by this iSphere.

getNumElements() - Method in class org.ispheres.shared.objects.Shape

getNumResults() - Method in class org.ispheres.client.SearchClient

This function returns the total number of results matching the initial search query that has been found to date.

getNumResults() - Method in class org.ispheres.shared.process.Search

This function returns the number of results found by the search process, please note - that the number of results found may increase over time as the iSphere galaxy is explored further.

getNumResults() - Method in interface org.ispheres.shared.process.SearchPublicInterface

This function returns the total number of results matching the initial search query that has been found to date.

getObject(int, int) - Method in class org.ispheres.client.ISphereClient

Retrieve the specified ISphereObject from the collection.

getObject(int) - Method in class org.ispheres.server.core.Collection

Fetches a digital object from the collection..

getObject(int, int) - Method in class org.ispheres.server.core.ISphere

Retrieve the specified ISphereObject from the collection.

GetObject - Class in org.ispheres.server.core.process

This is a process which can be used to fetch a digital object from the iSphere.

GetObject(int, Collection, int) - Constructor for class org.ispheres.server.core.process.GetObject

Constructor - This creates a process which will fetch a digital object from the iSphere.

getObject(int) - Method in class org.ispheres.server.core.SimpleRepositoryModel

Gets a digital object from the local repository.

getObject(int, int) - Method in interface org.ispheres.shared.core.ISpherePublicInterface

Retrieve the specified ISphereObject from the collection.

getObjectConnector() - Method in class org.ispheres.server.core.SimpleRepositoryModel

Returns the object connector that is being used by this simple repository model to read and write objects.

getObjectIndex() - Method in class org.ispheres.server.connectors.csvmetadata.ConfigurationFileProcessor

Get the location of the digital object.

getObjectLocation(int, int) - Method in class org.ispheres.server.connectors.csvmetadata.CSVDocumentProcessor

Fetches the location of the digital object that the metadata at metadataLocation describes.

getObjectLocation(String) - Method in class org.ispheres.server.connectors.csvmetadata.CSVMetadataConnector

Fetches the location of the digital object that the metadata at metadataLocation describes.

getObjectLocation(String) - Method in class org.ispheres.server.connectors.MetadataConnector

Fetches the location of the digital object that the metadata at metadataLocation describes.

getObjectLocation(String) - Method in class org.ispheres.server.connectors.MySQLJoinMetadataConnector

Fetches the location of the digital object that the metadata at metadataLocation describes.

getObjectLocation(String) - Method in class org.ispheres.server.connectors.MySQLMetadataConnector

Fetches the location of the digital object that the metadata at metadataLocation describes.

getObjectLocation(Schema) - Method in class org.ispheres.shared.objects.MetadataObject

Returns the String that identifies the location of the digital object based on the supplied Schema's object location field.

getObjectLocationElements() - Method in class org.ispheres.shared.core.Schema

Returns the list of unique identifiers for the elements that specify the location of the digital object that accompanies MetadataObjects using this Schema.

getObjectType() - Method in class org.ispheres.server.connectors.DigitalObjectConnector

getObjectType() - Method in class org.ispheres.server.core.Collection

Returns the type of ISphere object held in this collection.

getOffset() - Method in class org.ispheres.client.SearchClient

Search results are broken into pages, and as the user thumbs through these pages the offSet within the searchResult listing changes (the offSet indicates where in the search result listing the user is).

getOffset() - Method in class org.ispheres.shared.process.Search

This function returns the current offset of the searchResultCache - basically it is the starting index of the results to display.

getOffset() - Method in interface org.ispheres.shared.process.SearchPublicInterface

Search results are broken into pages, and as the user thumbs through these pages the offSet within the searchResult listing changes (the offSet indicates where in the search result listing the user is).

getOrder() - Method in class org.ispheres.shared.core.Element

Returns the order in which this element should appear when using multiple instances of the same element.

getParameterName(int) - Method in class org.ispheres.shared.transforms.TransformInterface

Returns the name of the parameter at the specified index.

getParameterName() - Method in class org.ispheres.shared.transforms.TransformInterface.Parameter

getParameters() - Method in class org.ispheres.shared.transforms.TransformInterface

Returns the list of parameters as an array of Parameter objects.

getParameterType(int) - Method in class org.ispheres.shared.transforms.TransformInterface

Returns the type of the parameter at the specified index.

getParameterType() - Method in class org.ispheres.shared.transforms.TransformInterface.Parameter

getParameterValue(int) - Method in class org.i