org.apache.jackrabbit.vault.fs

Class PropertyValueArtifact

java.lang.Object

AbstractArtifact

org.apache.jackrabbit.vault.fs.PropertyValueArtifact

All Implemented Interfaces:

Artifact, Dumpable, ExportArtifact

public class PropertyValueArtifact
extends AbstractArtifact
implements ExportArtifact

Implements a artifact that is based on a property value.

Constructor Summary

Constructors

Constructor and Description
PropertyValueArtifact(Artifact parent, java.lang.String relPath, java.lang.String ext, ArtifactType type, Property prop, int index, long lastModified)
PropertyValueArtifact(Artifact parent, java.lang.String relPath, java.lang.String ext, ArtifactType type, Property prop, long lastModified)

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<PropertyValueArtifact>	create(Artifact parent, java.lang.String relPath, java.lang.String ext, ArtifactType type, Property prop, long lastModified) Creates a collection of PropertyValueArtifact from the given property.
void	detach() Detaches the value from the underlying property value.
long	getContentLength() Returns the length of the serialized data if it's known without doing the actual serialization.
java.lang.String	getContentType() Returns the content type of the serialized data or null if the type is not known or cannot be determined.
VaultInputSource	getInputSource() Returns an input source to the contents of this artifact.
java.io.InputStream	getInputStream() Returns the input stream to the contents of this artifact.
long	getLastModified() Returns the last modified date or 0 if not known.
AccessType	getPreferredAccess() Returns the preferred access value for this artifact.
Property	getProperty() Returns the underlying property
SerializationType	getSerializationType() Returns the serialization type of this artifact.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.vault.fs.api.Artifact

getExtension, getPlatformPath, getRelativePath, getType, spool

Methods inherited from interface org.apache.jackrabbit.vault.fs.api.Dumpable

dump

Constructor Detail

PropertyValueArtifact

public PropertyValueArtifact(Artifact parent,
                             java.lang.String relPath,
                             java.lang.String ext,
                             ArtifactType type,
                             Property prop,
                             long lastModified)
                      throws RepositoryException

Throws:

RepositoryException

PropertyValueArtifact

public PropertyValueArtifact(Artifact parent,
                             java.lang.String relPath,
                             java.lang.String ext,
                             ArtifactType type,
                             Property prop,
                             int index,
                             long lastModified)
                      throws RepositoryException

Throws:

RepositoryException

Method Detail

create

public static java.util.Collection<PropertyValueArtifact> create(Artifact parent,
                                                                 java.lang.String relPath,
                                                                 java.lang.String ext,
                                                                 ArtifactType type,
                                                                 Property prop,
                                                                 long lastModified)
                                                          throws RepositoryException

Creates a collection of PropertyValueArtifact from the given property. If the property is multivalued there will be an artifact created for each value with the value index appended to it's name.

Parameters:

parent - parent artifact

relPath - the base name for the artifact(s).

ext - the extension

type - the type for the artifact(s).

prop - the property for the artifact(s).

lastModified - the last modified date.

Returns:

a collection of Artifacts.

Throws:

RepositoryException - if an error occurs

getSerializationType

public SerializationType getSerializationType()

Returns the serialization type of this artifact.

Specified by:

getSerializationType in interface Artifact

Returns:

the serialization type of this artifact.

getPreferredAccess

public AccessType getPreferredAccess()

Returns the preferred access value for this artifact.

Specified by:

getPreferredAccess in interface Artifact

Returns:

always AccessType.STREAM

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException,
                                          RepositoryException

Returns the input stream to the contents of this artifact. This is the preferred method to use for input-artifacts.

Specified by:

getInputStream in interface Artifact

Returns:

a input stream to the contents of this artifact.

Throws:

java.io.IOException - if an I/O error occurs

RepositoryException - if a repository error occurs

detach

public void detach()
            throws java.io.IOException,
                   RepositoryException

Detaches the value from the underlying property value.

Throws:

java.io.IOException - if an I/O error occurs

RepositoryException - if a repository error occurs.

getInputSource

public VaultInputSource getInputSource()
                                throws java.io.IOException,
                                       RepositoryException

Returns an input source to the contents of this artifact. This is also preferred for AccessType.STREAM.

Specified by:

getInputSource in interface Artifact

Returns:

a input source which systemId is the path of the underlying property

Throws:

java.io.IOException - if an I/O error occurs.

RepositoryException - of a repository error occurs.

getContentLength

public long getContentLength()

Returns the length of the serialized data if it's known without doing the actual serialization.

Specified by:

getContentLength in interface Artifact

Returns:

the length or -1 if the length cannot be determined.

getProperty

public Property getProperty()

Returns the underlying property

Returns:

the underlying property

getLastModified

public long getLastModified()

Returns the last modified date or 0 if not known.

Specified by:

getLastModified in interface Artifact

Returns:

the last modified date or 0

getContentType

public java.lang.String getContentType()

Returns the content type of the serialized data or null if the type is not known or cannot be determined.

Specified by:

getContentType in interface Artifact

Returns:

the content type or null.