org.dataone.client

Class D1TypeBuilder

java.lang.Object

org.dataone.client.D1TypeBuilder

public class D1TypeBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
D1TypeBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
static AccessRule	buildAccessRule(String subjectString, Permission permission)
static AccessRule	buildAccessRule(String subjectString, Permission[] permissions)
static ObjectFormatIdentifier	buildFormatIdentifier(String value)
static Identifier	buildIdentifier(String value)
static SystemMetadata	buildMinimalSystemMetadata(Identifier id, InputStream data, ObjectFormatIdentifier formatId, Subject rightsHolder) Builds a minimal and 'typical' SystemMetadata object containing all of the required fields needed for submission to DataONE at time of create.
static NodeReference	buildNodeReference(String value)
static Subject	buildSubject(String value) Validates the identifier checking for any invalid characters The only rule currently is no whitespace.
static Checksum	cloneChecksum(Checksum cs)
static ObjectFormatIdentifier	cloneFormatIdentifier(ObjectFormatIdentifier orig)
static Identifier	cloneIdentifier(Identifier orig)
static NodeReference	cloneNodeReference(NodeReference orig)
static Subject	cloneSubject(Subject orig)
static SystemMetadata	cloneSystemMetadata(SystemMetadata sm) Returns a clone of the given systemMetadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

D1TypeBuilder

public D1TypeBuilder()

Method Detail

buildNodeReference

public static NodeReference buildNodeReference(String value)

buildFormatIdentifier

public static ObjectFormatIdentifier buildFormatIdentifier(String value)

buildIdentifier

public static Identifier buildIdentifier(String value)

buildSubject

public static Subject buildSubject(String value)

Validates the identifier checking for any invalid characters The only rule currently is no whitespace.

Parameters:

identifier -

Returns:

true if the identifier is valid

buildAccessRule

public static AccessRule buildAccessRule(String subjectString,
                         Permission permission)

buildAccessRule

public static AccessRule buildAccessRule(String subjectString,
                         Permission[] permissions)

buildMinimalSystemMetadata

public static SystemMetadata buildMinimalSystemMetadata(Identifier id,
                                        InputStream data,
                                        ObjectFormatIdentifier formatId,
                                        Subject rightsHolder)
                                                 throws NoSuchAlgorithmException,
                                                        IOException,
                                                        NotFound,
                                                        ServiceFailure

Builds a minimal and 'typical' SystemMetadata object containing all of the required fields needed for submission to DataONE at time of create. 'Typical' in this case denotes that the rightsHolder and submitter are the same Subject. The formatId is nd the The Checksum and content length are derived from the InputStream.

Parameters:

id -

data -

formatId -

rightsHolder -

Returns:

Throws:

NoSuchAlgorithmException

IOException

NotFound

ServiceFailure

cloneSystemMetadata

public static SystemMetadata cloneSystemMetadata(SystemMetadata sm)

Returns a clone of the given systemMetadata. Note that some fields cloned, such as the replica list, are not necessarily functionally applicable to the new systemMetadata instance. for example, if you are using the clone method to template the systemmetadta for a different object.

Parameters:

sm -

Returns:

cloneIdentifier

public static Identifier cloneIdentifier(Identifier orig)

cloneSubject

public static Subject cloneSubject(Subject orig)

cloneFormatIdentifier

public static ObjectFormatIdentifier cloneFormatIdentifier(ObjectFormatIdentifier orig)

cloneNodeReference

public static NodeReference cloneNodeReference(NodeReference orig)

cloneChecksum

public static Checksum cloneChecksum(Checksum cs)