org.dataone.client.types

Class ObsoletesChain

java.lang.Object

org.dataone.client.types.ObsoletesChain

public class ObsoletesChain
extends Object

An object meant to contain information on the history of an object, including all of the objects the given pid obsoletes, and objects that obsolete it.

Author:

rnahf

Constructor Summary

Constructors

Constructor and Description
ObsoletesChain(Identifier pid)

Method Summary

Methods

Modifier and Type	Method and Description
void	addObject(Identifier pid, Date publishDate, Identifier obsoletes, Identifier obsoletedBy, Boolean isArchived)
Identifier	getByPosition(int index)
Identifier	getLatestVersion()
Identifier	getOriginalVersion()
Date	getPublishDate(Identifier pid)
Identifier	getStartingPoint()
Identifier	getVersionAsOf(Date asOfDate)
Boolean	isArchived(Identifier pid)
boolean	isComplete() An ObsoletesChain is complete when the earliest and latest links have no obsoletedBy and obsoletes, respectively.
boolean	isLatestVersion(Identifier pid)
Boolean	latestIsArchived()
Identifier	nextVersion(Identifier pid)
Identifier	previousVersion(Identifier pid)
int	size() returns the size of the chain (count of the number of items)

Methods inherited from class java.lang.Object

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

Constructor Detail

ObsoletesChain

public ObsoletesChain(Identifier pid)

Method Detail

getStartingPoint

public Identifier getStartingPoint()

addObject

public void addObject(Identifier pid,
             Date publishDate,
             Identifier obsoletes,
             Identifier obsoletedBy,
             Boolean isArchived)

getVersionAsOf

public Identifier getVersionAsOf(Date asOfDate)

nextVersion

public Identifier nextVersion(Identifier pid)

previousVersion

public Identifier previousVersion(Identifier pid)

getLatestVersion

public Identifier getLatestVersion()

getOriginalVersion

public Identifier getOriginalVersion()

getByPosition

public Identifier getByPosition(int index)

size

public int size()

returns the size of the chain (count of the number of items)

Returns:

isComplete

public boolean isComplete()

An ObsoletesChain is complete when the earliest and latest links have no obsoletedBy and obsoletes, respectively.

isArchived

public Boolean isArchived(Identifier pid)

latestIsArchived

public Boolean latestIsArchived()

getPublishDate

public Date getPublishDate(Identifier pid)

isLatestVersion

public boolean isLatestVersion(Identifier pid)