Package ddf.catalog.core.versioning.impl

Class MetacardVersionImpl

java.lang.Object

ddf.catalog.data.impl.MetacardImpl

ddf.catalog.core.versioning.impl.MetacardVersionImpl

All Implemented Interfaces:

ddf.catalog.core.versioning.MetacardVersion, ddf.catalog.data.Metacard, Serializable

public class MetacardVersionImpl
extends MetacardImpl
implements ddf.catalog.core.versioning.MetacardVersion

Experimental. Subject to change.
Represents a version at a particular instant. Also included are the MetacardVersion.Action that was performed, who it was edited by, and what time it was edited on.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ddf.catalog.core.versioning.MetacardVersion

ddf.catalog.core.versioning.MetacardVersion.Action

Field Summary

Fields inherited from class ddf.catalog.data.impl.MetacardImpl

BASIC_METACARD

Fields inherited from interface ddf.catalog.data.Metacard

ANY_DATE, ANY_GEO, ANY_TEXT, CHECKSUM, CHECKSUM_ALGORITHM, CONTENT_TYPE, CONTENT_TYPE_VERSION, CREATED, DEFAULT_TAG, DERIVED, DERIVED_RESOURCE_DOWNLOAD_URL, DERIVED_RESOURCE_URI, DESCRIPTION, EFFECTIVE, EXPIRATION, GEOGRAPHY, ID, METADATA, MODIFIED, POINT_OF_CONTACT, RELATED, RESOURCE_DOWNLOAD_URL, RESOURCE_SIZE, RESOURCE_URI, SECURITY, SECURITY_MATCH_ALL, SECURITY_MATCH_ONE, SOURCE_ID, TAGS, TARGET_NAMESPACE, THUMBNAIL, TITLE

Fields inherited from interface ddf.catalog.core.versioning.MetacardVersion

ACTION, EDITED_BY, HISTORY_METACARDS_PROPERTY, PREFIX, PREFIXER, SKIP_VERSIONING, VERSION_OF_ID, VERSION_TAG, VERSION_TAGS, VERSION_TYPE, VERSION_TYPE_BINARY, VERSIONED_ON, VERSIONED_RESOURCE_URI

Constructor Summary

Constructors

Constructor	Description
MetacardVersionImpl(String id, ddf.catalog.data.Metacard sourceMetacard, ddf.catalog.core.versioning.MetacardVersion.Action action, org.apache.shiro.subject.Subject subject, ddf.security.SubjectOperations subjectOperations)	Will convert the given Metacard to a MetacardVersionImpl by cloning it and adding the current subject, time, and a random UUID.
MetacardVersionImpl(String id, ddf.catalog.data.Metacard sourceMetacard, ddf.catalog.core.versioning.MetacardVersion.Action action, org.apache.shiro.subject.Subject subject, ddf.security.SubjectOperations subjectOperations, List<ddf.catalog.data.MetacardType> types)	Will convert the given Metacard to a MetacardVersionImpl by cloning it and adding the current subject, time, and a random UUID.

Method Summary

Modifier and Type	Method	Description
ddf.catalog.core.versioning.MetacardVersion.Action	getAction()
String	getEditedBy()
ddf.catalog.data.Metacard	getMetacard()	Reverts the MetacardVersionImpl to the original Metacard
ddf.catalog.data.Metacard	getMetacard(List<ddf.catalog.data.MetacardType> types)	Deprecated. The metacard types passed in are no longer used
static ddf.catalog.data.MetacardType	getMetacardVersionType()
Date	getVersionedOn()
String	getVersionOfId()
URI	getVersionResourceUri()
Set<String>	getVersionTags()
byte[]	getVersionType()
String	getVersionTypeBinary()
static boolean	isNotVersion(ddf.catalog.data.Metacard metacard)
static boolean	isVersion(ddf.catalog.data.Metacard metacard)
void	setAction(ddf.catalog.core.versioning.MetacardVersion.Action action)
void	setEditedBy(String editedBy)
void	setVersionedOn(Date date)
void	setVersionOfId(String idHistory)
void	setVersionResourceUri(String uri)
void	setVersionResourceUri(URI uri)
void	setVersionTags(Set<String> tags)
void	setVersionType(String versionType)
void	setVersionTypeBinary(byte[] versionType)
static ddf.catalog.data.Metacard	toMetacard(ddf.catalog.data.Metacard source)	Reverts the passed in Metacard to the original Metacard IF it is a version metacard.
static ddf.catalog.data.Metacard	toMetacard(ddf.catalog.data.Metacard source, List<ddf.catalog.data.MetacardType> types)	Deprecated. The metacard types passed in are no longer used
protected static ddf.catalog.core.versioning.MetacardVersion	toVersion(ddf.catalog.data.Metacard metacard)

Methods inherited from class ddf.catalog.data.impl.MetacardImpl

equals, getAttribute, getContentTypeName, getContentTypeNamespace, getContentTypeVersion, getCreatedDate, getDescription, getEffectiveDate, getExpirationDate, getId, getLocation, getMetacardType, getMetadata, getModifiedDate, getPointOfContact, getResourceSize, getResourceURI, getSecurity, getSourceId, getThumbnail, getTitle, hashCode, requestBytes, requestData, requestDate, requestDouble, requestInputStream, requestInteger, requestLong, requestString, setAttribute, setAttribute, setContentTypeName, setContentTypeVersion, setCreatedDate, setDescription, setEffectiveDate, setExpirationDate, setId, setLocation, setMetadata, setModifiedDate, setPointOfContact, setResourceSize, setResourceURI, setSecurity, setSourceId, setTags, setTargetNamespace, setThumbnail, setTitle, setType

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.data.Metacard

getAttribute, getContentTypeName, getContentTypeNamespace, getContentTypeVersion, getCreatedDate, getEffectiveDate, getExpirationDate, getId, getLocation, getMetacardType, getMetadata, getModifiedDate, getResourceSize, getResourceURI, getSourceId, getTags, getThumbnail, getTitle, setAttribute, setSourceId

Constructor Details

MetacardVersionImpl

public MetacardVersionImpl(String id,
 ddf.catalog.data.Metacard sourceMetacard,
 ddf.catalog.core.versioning.MetacardVersion.Action action,
 org.apache.shiro.subject.Subject subject,
 ddf.security.SubjectOperations subjectOperations)

Will convert the given Metacard to a MetacardVersionImpl by cloning it and adding the current subject, time, and a random UUID. Cannot take a MetacardVersionImpl as the sourceMetacard.

Parameters:

sourceMetacard - Metacard to clone and create a history item from

action - Which action was done to modify the metacard

Throws:

IllegalArgumentException

MetacardVersionImpl

public MetacardVersionImpl(String id,
 ddf.catalog.data.Metacard sourceMetacard,
 ddf.catalog.core.versioning.MetacardVersion.Action action,
 org.apache.shiro.subject.Subject subject,
 ddf.security.SubjectOperations subjectOperations,
 List<ddf.catalog.data.MetacardType> types)

Will convert the given Metacard to a MetacardVersionImpl by cloning it and adding the current subject, time, and a random UUID. Cannot take a MetacardVersionImpl as the sourceMetacard.
The MetacardTypes list will affect whether the metacard type is stored by name or entirely by serializing the type and storing it in the metacard.

Parameters:

sourceMetacard - Metacard to clone and create a history item from

action - Which action was done to modify the metacard

types - A list of currently defined types in the system

Throws:

IllegalArgumentException

Method Details

getMetacard

@Deprecated
public ddf.catalog.data.Metacard getMetacard(List<ddf.catalog.data.MetacardType> types)

Deprecated.

The metacard types passed in are no longer used

Reverts the MetacardVersionImpl to the original Metacard

Returns:

the original metacard this version represents

getMetacard

public ddf.catalog.data.Metacard getMetacard()

Reverts the MetacardVersionImpl to the original Metacard

Returns:

The original metacard this version represents

toMetacard

@Deprecated
public static ddf.catalog.data.Metacard toMetacard(ddf.catalog.data.Metacard source,
 List<ddf.catalog.data.MetacardType> types)

Deprecated.

The metacard types passed in are no longer used

Reverts the passed in Metacard to the original Metacard IF it is a version metacard.

Returns:

The original metacard this version represents

toMetacard

public static ddf.catalog.data.Metacard toMetacard(ddf.catalog.data.Metacard source)

Reverts the passed in Metacard to the original Metacard IF it is a version metacard.

Parameters:

source - The metacard to revert

Returns:

The original metacard this version represents

toVersion

protected static ddf.catalog.core.versioning.MetacardVersion toVersion(ddf.catalog.data.Metacard metacard)

isNotVersion

public static boolean isNotVersion(@Nullable
 ddf.catalog.data.Metacard metacard)

isVersion

public static boolean isVersion(@Nullable
 ddf.catalog.data.Metacard metacard)

getVersionResourceUri

public URI getVersionResourceUri()

setVersionResourceUri

public void setVersionResourceUri(String uri)

setVersionResourceUri

public void setVersionResourceUri(URI uri)

getVersionOfId

public String getVersionOfId()

setVersionOfId

public void setVersionOfId(String idHistory)

getVersionedOn

public Date getVersionedOn()

setVersionedOn

public void setVersionedOn(Date date)

getEditedBy

public String getEditedBy()

setEditedBy

public void setEditedBy(String editedBy)

getVersionType

public byte[] getVersionType()

setVersionType

public void setVersionType(String versionType)

getVersionTypeBinary

public String getVersionTypeBinary()

setVersionTypeBinary

public void setVersionTypeBinary(byte[] versionType)

getAction

public ddf.catalog.core.versioning.MetacardVersion.Action getAction()

setAction

public void setAction(ddf.catalog.core.versioning.MetacardVersion.Action action)

getVersionTags

public Set<String> getVersionTags()

setVersionTags

public void setVersionTags(Set<String> tags)

getMetacardVersionType

public static ddf.catalog.data.MetacardType getMetacardVersionType()