org.nuxeo.ecm.spaces.api
Class AbstractSpaceProvider

java.lang.Object
  org.nuxeo.ecm.spaces.api.AbstractSpaceProvider

All Implemented Interfaces:

SpaceProvider

Direct Known Subclasses:

RootDocSpaceProvider, SingleDocSpaceProvider

public abstract class AbstractSpaceProvider
extends java.lang.Object
implements SpaceProvider

Constructor Summary

AbstractSpaceProvider()

Method Summary

void	add(Space o, CoreSession session)
void	addAll(java.util.Collection<? extends Space> c, CoreSession session)
void	clear(CoreSession session)
java.util.List<Space>	getAllSpaces(CoreSession session) Gets all Spaces supplied by SpaceProvider.
static java.lang.String	getColumnId(int n)
java.lang.String	getName() Gets SpaceProvider's name.
Space	getSpace(java.lang.String spaceName, CoreSession session)
void	initialize(java.util.Map<java.lang.String,java.lang.String> params)
boolean	isEmpty(CoreSession session)
boolean	remove(Space space, CoreSession session)
long	size(CoreSession session)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.spaces.api.SpaceProvider

getAll, isReadOnly

Constructor Detail

AbstractSpaceProvider

public AbstractSpaceProvider()

Method Detail

add

public void add(Space o,
                CoreSession session)
         throws SpaceException

Specified by:

add in interface SpaceProvider

Throws:

SpaceException

addAll

public void addAll(java.util.Collection<? extends Space> c,
                   CoreSession session)
            throws SpaceException

Specified by:

addAll in interface SpaceProvider

Throws:

SpaceException

clear

public void clear(CoreSession session)
           throws SpaceException

Specified by:

clear in interface SpaceProvider

Throws:

SpaceException

getSpace

public final Space getSpace(java.lang.String spaceName,
                            CoreSession session)
                     throws SpaceException

Specified by:

getSpace in interface SpaceProvider

Throws:

SpaceException

isEmpty

public boolean isEmpty(CoreSession session)
                throws SpaceException

Specified by:

isEmpty in interface SpaceProvider

Throws:

SpaceException

size

public long size(CoreSession session)
          throws SpaceException

Specified by:

size in interface SpaceProvider

Throws:

SpaceException

initialize

public void initialize(java.util.Map<java.lang.String,java.lang.String> params)
                throws java.lang.Exception

Specified by:

initialize in interface SpaceProvider

Throws:

java.lang.Exception

remove

public boolean remove(Space space,
                      CoreSession session)
               throws SpaceException

Specified by:

remove in interface SpaceProvider

Throws:

SpaceException

getName

public final java.lang.String getName()
                               throws SpaceException

Description copied from interface: SpaceProvider

Gets SpaceProvider's name.

Specified by:

getName in interface SpaceProvider

Returns:

provider name

Throws:

SpaceException - if space manager is not reachable

getAllSpaces

public final java.util.List<Space> getAllSpaces(CoreSession session)

Description copied from interface: SpaceProvider

Gets all Spaces supplied by SpaceProvider. This method does not throw any exception, it can be useful in some cases.

Specified by:

getAllSpaces in interface SpaceProvider

Parameters:

session - core session

Returns:

list of Space OR an empty list if no spaces are supplied by space provider (never returns null)

getColumnId

public static java.lang.String getColumnId(int n)