Package org.apache.jackrabbit.vault.fs.api

Interface Aggregate

All Superinterfaces:

Dumpable

All Known Implementing Classes:

AggregateImpl

public interface Aggregate
extends Dumpable

Aggregate...

Method Summary

Modifier and Type	Method	Description
boolean	allowsChildren()	Checks if this artifact node possibly allows children, i.e.
Aggregate	getAggregate(String relPath)
ArtifactSet	getArtifacts()	Returns the artifacts of this node.
Collection<Property>	getBinaries()	Returns the collection of binary properties in this aggregate
List<? extends Aggregate>	getLeaves()	Returns the leaves of this aggregate or null.
AggregateManager	getManager()	Returns the artifact manager this node belongs to.
String	getName()	Returns the name of this aggregate.
String[]	getNamespacePrefixes()
String	getNamespaceURI(String prefix)
Node	getNode()
Aggregate	getParent()
String	getPath()
String	getRelPath()	Returns the relative path of this aggregate in respect to it's parent aggregate.
RepositoryAddress	getRepositoryAddress()	Returns the (absolute) repository address to the node that this artifact node represents.
boolean	hasNode()
boolean	isAttached()	Checks if this aggregate has an aggregator and its node exists.

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

dump

Method Detail

getNode

Node getNode()
      throws RepositoryException

Throws:

RepositoryException

hasNode

boolean hasNode()
         throws RepositoryException

Throws:

RepositoryException

getParent

Aggregate getParent()

getPath

String getPath()

getRepositoryAddress

RepositoryAddress getRepositoryAddress()
                                throws RepositoryException

Returns the (absolute) repository address to the node that this artifact node represents.

Returns:

the repository address

Throws:

RepositoryException - if an error occurs.

allowsChildren

boolean allowsChildren()

Checks if this artifact node possibly allows children, i.e. is a folder.

Returns:

true if this artifact node allows children; false otherwise.

getRelPath

String getRelPath()

Returns the relative path of this aggregate in respect to it's parent aggregate.

Returns:

the relative path

getName

String getName()

Returns the name of this aggregate.

Returns:

the name of this aggregate.

getLeaves

List<? extends Aggregate> getLeaves()
                             throws RepositoryException

Returns the leaves of this aggregate or null.

Returns:

the leaves

Throws:

RepositoryException - if an error occurs

getAggregate

Aggregate getAggregate(String relPath)
                throws RepositoryException

Throws:

RepositoryException

getArtifacts

ArtifactSet getArtifacts()
                  throws RepositoryException

Returns the artifacts of this node.

Returns:

the artifacts

Throws:

RepositoryException - if this file is not attached to the fs, yet.

getManager

AggregateManager getManager()

Returns the artifact manager this node belongs to.

Returns:

the Vault filesystem.

isAttached

boolean isAttached()
            throws RepositoryException

Checks if this aggregate has an aggregator and its node exists.

Returns:

true if this aggregate is attached

Throws:

RepositoryException - if an error occurs

getNamespacePrefixes

String[] getNamespacePrefixes()

getNamespaceURI

String getNamespaceURI(String prefix)
                throws RepositoryException

Throws:

RepositoryException

getBinaries

Collection<Property> getBinaries()

Returns the collection of binary properties in this aggregate

Returns:

the binaries or null