info.sswap.ontologies.data.api
Class DataFactory

java.lang.Object
  extended by info.sswap.ontologies.data.api.DataFactory

public class DataFactory
extends java.lang.Object

Main entry point for support for the data ontology. Use this factory to create a data object to allow reading/writing of literal or resource data, with optional "attachment" (literal data base64 encoding and decoding) or HTTP Basic authentication.

Author:
Damian Gessler

Nested Class Summary
static class DataFactory.Open
          Directives on how to open data elements for reading and writing.
 
Constructor Summary
DataFactory()
           
 
Method Summary
private static Data constructor(SSWAPIndividual sswapIndividual, DataFactory.Open state, boolean attachment, boolean httpAuth, java.lang.String username, java.lang.String passwd)
           
static Data Data(SSWAPIndividual sswapIndividual)
          Open with automatic support for literal or resource data, including automatic support for base64 encoded attachments.
static Data Data(SSWAPIndividual sswapIndividual, DataFactory.Open state)
          Open with automatic support for base64 encoded attachments.
static Data Data(SSWAPIndividual sswapIndividual, DataFactory.Open state, java.lang.String username, java.lang.String passwd)
          Open with automatic support for base64 encoded attachments or HTTP Basic Authentication.
static Directory Directory(SSWAPIndividual sswapIndividual)
          Create a new Directory from the subject individual.
private static boolean hasLiteralData(SSWAPIndividual sswapIndividual)
           
private static boolean isURL(SSWAPIndividual sswapIndividual)
           
static Data RawData(SSWAPIndividual sswapIndividual, DataFactory.Open state)
          Raw data (no base64 encoding or decoding).
static Data RawData(SSWAPIndividual sswapIndividual, DataFactory.Open state, java.lang.String username, java.lang.String passwd)
          Raw data (no base64 encoding or decoding) with HTTP Basic Authentication.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataFactory

public DataFactory()
Method Detail

Data

public static Data Data(SSWAPIndividual sswapIndividual)
                 throws DataException
Open with automatic support for literal or resource data, including automatic support for base64 encoded attachments.

Parameters:
sswapIndividual - the individual from which to read the data
Returns:
Data a data object to allow reading and writing
Throws:
DataException - on any error establishing data support
See Also:
LiteralData

Data

public static Data Data(SSWAPIndividual sswapIndividual,
                        DataFactory.Open state)
                 throws DataException
Open with automatic support for base64 encoded attachments.

Parameters:
sswapIndividual - the individual from which to read the data
state - directive on how to handle the data source/sink
Returns:
Data a data object to allow reading and writing
Throws:
DataException - on any error establishing data support
See Also:
LiteralData

Data

public static Data Data(SSWAPIndividual sswapIndividual,
                        DataFactory.Open state,
                        java.lang.String username,
                        java.lang.String passwd)
                 throws DataException
Open with automatic support for base64 encoded attachments or HTTP Basic Authentication.

Parameters:
sswapIndividual - the individual from which to read the data
state - directive on how to handle the data source/sink
username - User name as defined for HTTP Basic Authentication
passwd - Password as defined for HTTP Basic Authentication
Returns:
Data a data object to allow reading and writing
Throws:
DataException - on any error establishing data support
See Also:
LiteralData, ResourceData

RawData

public static Data RawData(SSWAPIndividual sswapIndividual,
                           DataFactory.Open state)
                    throws DataException
Raw data (no base64 encoding or decoding).

Parameters:
sswapIndividual - the individual from which to read the data
state - directive on how to handle the data source/sink
Returns:
Data a data object to allow reading and writing
Throws:
DataException - on any error establishing data support
See Also:
LiteralData, ResourceData

RawData

public static Data RawData(SSWAPIndividual sswapIndividual,
                           DataFactory.Open state,
                           java.lang.String username,
                           java.lang.String passwd)
                    throws DataException
Raw data (no base64 encoding or decoding) with HTTP Basic Authentication.

Parameters:
sswapIndividual - the individual from which to read the data
state - directive on how to handle the data source/sink
username - User name as defined for HTTP Basic Authentication
passwd - Password as defined for HTTP Basic Authentication
Returns:
Data a data object to allow reading and writing
Throws:
DataException - on any error establishing data support
See Also:
ResourceData

constructor

private static Data constructor(SSWAPIndividual sswapIndividual,
                                DataFactory.Open state,
                                boolean attachment,
                                boolean httpAuth,
                                java.lang.String username,
                                java.lang.String passwd)

Directory

public static Directory Directory(SSWAPIndividual sswapIndividual)
                           throws DataException
Create a new Directory from the subject individual.

Parameters:
sswapIndividual - Individual for which to inspect for data:hasData properties.
Returns:
a Directory of Data.
Throws:
DataException - upon Data(SSWAPIndividual) failure

hasLiteralData

private static boolean hasLiteralData(SSWAPIndividual sswapIndividual)

isURL

private static boolean isURL(SSWAPIndividual sswapIndividual)


Copyright (c) 2011, iPlant Collaborative, University of Arizona, Cold Spring Harbor Laboratories, University of Texas at Austin.