org.omwg.versioning
Interface VersionInformation

public interface VersionInformation

This interface represents metadata of an ontology version.

Author:

jacek

Field Summary

static java.lang.String	COMMENT_KEY The key under which comment is stored (as String) in the general metadata map.
static java.lang.String	DATE_KEY The key under which creation date is stored (as String) in the general metadata map.
static java.lang.String	USER_KEY The key under which user credentials are stored (as String) in the general metadata map.

Method Summary

java.lang.String	getComment() Returns the user comment pertaining this version.
java.util.Date	getDate() Returns the date of creation of this version.
UserCredentials	getUser() Returns the credentials of the user that created this version.
VersionIdentifier	getVersion() Returns the version identifier for which these metadata apply.
java.util.Map	getVersionMetadata() Returns the generic metadata holder on this version.

Field Detail

USER_KEY

static final java.lang.String USER_KEY

The key under which user credentials are stored (as String) in the general metadata map.

See Also:

Constant Field Values

DATE_KEY

static final java.lang.String DATE_KEY

The key under which creation date is stored (as String) in the general metadata map.

See Also:

Constant Field Values

COMMENT_KEY

static final java.lang.String COMMENT_KEY

The key under which comment is stored (as String) in the general metadata map.

See Also:

Constant Field Values

Method Detail

getVersion

VersionIdentifier getVersion()

Returns the version identifier for which these metadata apply.

Returns:

the version identifier for which these metadata apply.

getUser

UserCredentials getUser()

Returns the credentials of the user that created this version.

Returns:

the credentials of the user that created this version.

getDate

java.util.Date getDate()

Returns the date of creation of this version.

Returns:

the date of creation of this version.

getComment

java.lang.String getComment()

Returns the user comment pertaining this version.

Returns:

the user comment pertaining this version.

getVersionMetadata

java.util.Map getVersionMetadata()

Returns the generic metadata holder on this version. This map will also contain the other values accessible using the other methods of this interface.

Returns:

the generic metadata holder on this version.