Package org.silverpeas.core.admin.service

Class SpaceWithSubSpacesAndComponents

java.lang.Object

org.silverpeas.core.admin.service.SpaceWithSubSpacesAndComponents

public class SpaceWithSubSpacesAndComponents
extends Object

Representation of a Silverpeas's space and component structure more or less filtered.

This representation is essentially used by services using caches in order to provide as fast as possible the data.

When this object is initialized from the root space (which does not exist physically in data), getSubSpaces() must be used to start parsing the data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpaceWithSubSpacesAndComponents.ComponentInstanceSelector	This class permits to select component instances from a SpaceWithSubSpacesAndComponents representing a current view according some rules.

Constructor Summary

Constructors

Constructor	Description
SpaceWithSubSpacesAndComponents(SpaceInstLight space)

Method Summary

Modifier and Type	Method	Description
SpaceWithSubSpacesAndComponents.ComponentInstanceSelector	componentInstanceSelector()	Gets an instance of SpaceWithSubSpacesAndComponents.ComponentInstanceSelector initialize from the current view the current instance is representing.
List<SilverpeasComponentInstance>	getComponents()	Gets the list of component of current space.
SpaceInstLight	getSpace()	Gets the data of current space.
List<SpaceWithSubSpacesAndComponents>	getSubSpaces()	Gets the list of space just under the current space.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceWithSubSpacesAndComponents

public SpaceWithSubSpacesAndComponents(SpaceInstLight space)

Method Detail

getSpace

public SpaceInstLight getSpace()

Gets the data of current space.

The only way to check if the space is the root one (which does not exist physically into data) is to use SpaceInstLight.isRoot() method.
Please not checking by using SpaceInstLight.getId() method which could eventually throwing exception.

Returns:

the SpaceInstLight representing the current space.

getSubSpaces

public List<SpaceWithSubSpacesAndComponents> getSubSpaces()

Gets the list of space just under the current space.

Returns:

list of SpaceWithSubSpacesAndComponents instances.

getComponents

public List<SilverpeasComponentInstance> getComponents()

Gets the list of component of current space.

Returns:

list of ComponentInstLight instances.

componentInstanceSelector

public SpaceWithSubSpacesAndComponents.ComponentInstanceSelector componentInstanceSelector()

Gets an instance of SpaceWithSubSpacesAndComponents.ComponentInstanceSelector initialize from the current view the current instance is representing.

Returns:

a SpaceWithSubSpacesAndComponents.ComponentInstanceSelector instance which MUST be parametrized by using SpaceWithSubSpacesAndComponents.ComponentInstanceSelector.fromAllSpaces(), SpaceWithSubSpacesAndComponents.ComponentInstanceSelector.fromSpaces(Set) or SpaceWithSubSpacesAndComponents.ComponentInstanceSelector.fromSubSpacesOfSpaces(Set) before calling SpaceWithSubSpacesAndComponents.ComponentInstanceSelector.select().