Package org.silverpeas.cmis.walkers

Class TreeWalkerForSpaceInst

    • Constructor Detail

      • TreeWalkerForSpaceInst

        protected TreeWalkerForSpaceInst()

    • Method Detail

      • getSilverpeasObjectById

        protected SpaceInstLight getSilverpeasObjectById​(String objectId)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Gets in Silverpeas the object identified by the specified unique identifier. The way how to get such an object depends on its type and it is then delegated to the walker that handles such a type of Silverpeas objects.
        Specified by:
        getSilverpeasObjectById in class AbstractCmisObjectsTreeWalker
        Parameters:
        objectId - the unique identifier of an object in Silverpeas.
        Returns:
        a Silverpeas object or null if no such object exists.

      • encodeToCmisObject

        protected Space encodeToCmisObject​(LocalizedResource space,
                                   String language)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Encodes the specified Silverpeas object into its CMIS counterpart. The CMIS representation depends on the concrete type of the Silverpeas object. The way how create such a CMIS object depends on the type of the Silverpeas object and it is then delegated to the walker that handles such a type of Silverpeas objects.
        Specified by:
        encodeToCmisObject in class AbstractCmisObjectsTreeWalker
        Parameters:
        space - a localized resource in Silverpeas.
        language - the language to use in the localization of the CMIS object.
        Returns:
        a CmisObject instance.

      • isObjectSupported

        protected boolean isObjectSupported​(String objectId)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Is the object with the specified identifier supported by this walker?
        Specified by:
        isObjectSupported in class AbstractCmisObjectsTreeWalker
        Parameters:
        objectId - the unique identifier of an object.
        Returns:
        true if the walker knows how to work with objects with such an identifier pattern. False otherwise.

      • isTypeSupported

        protected boolean isTypeSupported​(TypeId typeId)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Is the specified CMIS type supported by this walker?
        Specified by:
        isTypeSupported in class AbstractCmisObjectsTreeWalker
        Parameters:
        typeId - the unique identifier of a CMIS type.
        Returns:
        true if the walker knows how to work with objects of the specified CMIS type. False otherwise.

      • getAllowedChildrenOfSilverpeasObject

        protected Stream<LocalizedResource> getAllowedChildrenOfSilverpeasObject​(ResourceIdentifier parentId,
                                                                         User user)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Gets in Silverpeas all the children objects of the specified parent and that are accessible to the given user. The way how to get such an object depends on its type and it is then delegated to the walker that handles such a type of Silverpeas objects.
        Specified by:
        getAllowedChildrenOfSilverpeasObject in class AbstractCmisObjectsTreeWalker
        Parameters:
        parentId - the unique identifier of the parent in Silverpeas.
        user - the user for which the children are get.
        Returns:
        a stream over all the allowed children of the specified parent in Silverpeas.

      • getParentsData

        public List<org.apache.chemistry.opencmis.commons.data.ObjectParentData> getParentsData​(String objectId,
                                                                                        Filtering filtering)
        Description copied from interface: CmisObjectsTreeWalker
        Gets a list of the CMIS data of the Silverpeas objects that are the direct parents of the CMIS object uniquely identified by the specified identifier. Only the data satisfying the given filtering rules are returned. A file-able CMIS object can have one or more parents but in Silverpeas, only publications in an EDM can have more than one parent (through the aliasing mechanism), so unless the object referred by the specified identifier is an aliased publication, this method returns usually a list with one element.
        Specified by:
        getParentsData in interface CmisObjectsTreeWalker
        Overrides:
        getParentsData in class AbstractCmisObjectsTreeWalker
        Parameters:
        objectId - the unique identifier of a Silverpeas resource or contribution.
        filtering - the filtering rules to apply on the CMIS data to return.
        Returns:
        a list of ObjectParentData elements, each of them being a wrapper of an ObjectData instance with the path of the specified object relative to this parent. The CMIS data are carried by the ObjectData object. If the specified object isn't file-able or it is the root folder (the virtual root space in Silverpeas), then an empty list is returned.

      • getChildrenData

        public org.apache.chemistry.opencmis.commons.data.ObjectInFolderList getChildrenData​(String folderId,
                                                                                     Filtering filtering,
                                                                                     Paging paging)
        Description copied from interface: CmisObjectsTreeWalker
        Gets a list of CMIS data of the Silverpeas objects that are children of the CMIS folder uniquely identified by the specified identifier. The CMIS folder represents a Silverpeas resource that is a container of others Silverpeas resources (space, component instance, ...). If this method is invoked for a document instead of a folder, then an empty ObjectInFolderList list should be returned.
        Specified by:
        getChildrenData in interface CmisObjectsTreeWalker
        Overrides:
        getChildrenData in class AbstractCmisObjectsTreeWalker
        Parameters:
        folderId - the unique identifier of a Silverpeas resource.
        filtering - the filtering rules to apply on the CMIS data to return.
        paging - the paging to apply on the elements of the list.
        Returns:
        an ObjectInFolderList instance that is a list of ObjectInFolderData elements, each of them being a decorator of an ObjectData instance with its path in the CMIS repository tree (if asked by the filtering). The CMIS data are carried by the ObjectData object. If the folder has no children, then an empty ObjectInFolderList instance is returned.

      • getSubTreeData

        public List<org.apache.chemistry.opencmis.commons.data.ObjectInFolderContainer> getSubTreeData​(String folderId,
                                                                                               Filtering filtering,
                                                                                               long depth)
        Description copied from interface: CmisObjectsTreeWalker
        Gets the CMIS objects subtree rooted to the CMIS folder uniquely identified by the specified identifier. The CMIS folder represents a Silverpeas resource that is a container of others Silverpeas resources (space, component instance, ...). A list of the direct children of the folder (ObjectInFolderContainer instances) is returned with, for each of them, if any, their own direct children and so on. Each child is described by their CMIS data (a decorator ObjectInFolderData of an ObjectData instance) filtered with the given filtering rules. If this method is invoked for a document instead of a folder, then an empty list should be returned.
        Specified by:
        getSubTreeData in interface CmisObjectsTreeWalker
        Overrides:
        getSubTreeData in class AbstractCmisObjectsTreeWalker
        Parameters:
        folderId - the unique identifier of a Silverpeas resource.
        filtering - the filtering rules to apply on the CMIS data to return.
        depth - the maximum depth of the subtree to return from the specified folder. If -1, the subtree will contain all the descendents at all depth levels. If 0, nothing. If 1, only the direct children. If greater than 1 only children of the folder and descendants up to the given levels deep. Any other values throws an IllegalArgumentException error.
        Returns:
        a list of ObjectInFolderContainer elements (the direct children), each of them being a container of others ObjectInFolderContainer objects (recursive walk of children) and described by an ObjectInFolderData instance that is a decorator of an ObjectData instance (the CMIS data) with its path in the CMIS repository tree (if asked by the filtering). The CMIS data are carried by the ObjectData object. If the folder has no children, then an empty list is returned.

      • browseObjectsInFolderTree

        protected List<org.apache.chemistry.opencmis.commons.data.ObjectInFolderContainer> browseObjectsInFolderTree​(LocalizedResource object,
                                                                                                             Filtering filtering,
                                                                                                             long depth)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Browses for the objects in the CMIS tree rooted at the specified object in Silverpeas. The browsing depends on the type of the specified object in Silverpeas and it is then delegated to the walker that knows how to browse a tree rooted at such a tree.
        Specified by:
        browseObjectsInFolderTree in class AbstractCmisObjectsTreeWalker
        Parameters:
        object - an identifiable object in Silverpeas.
        filtering - the filtering rules to apply on the CMIS data to return.
        depth - the depth of the browsing of the tree.
        Returns:
        a list of ObjectInFolderContainer elements (the direct children), each of them being a container of others ObjectInFolderContainer objects (recursive walk of the different tree's nodes) and described by an ObjectInFolderData instance that is a decorator of an ObjectData instance (the CMIS data) with its path in the CMIS repository tree (if asked by the filtering). The CMIS data are carried by the ObjectData object.

      • browseObjectsInFolder

        protected org.apache.chemistry.opencmis.commons.data.ObjectInFolderList browseObjectsInFolder​(LocalizedResource object,
                                                                                              Filtering filtering,
                                                                                              Paging paging)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Browses for the direct children in the CMIS folder represented by the specified Silverpeas object. the browsing of children depends on the type of the specified object in Silverpeas and it is then delegated to the walker that knows how to browse for children such an object.
        Specified by:
        browseObjectsInFolder in class AbstractCmisObjectsTreeWalker
        Parameters:
        object - an identifiable object in Silverpeas.
        filtering - the filtering rules to apply on the CMIS data to return.
        paging - the paging to apply on the elements of the list.
        Returns:
        an ObjectInFolderList instance that is a list of ObjectInFolderData elements, each of them being a decorator of an ObjectData instance with its path in the CMIS repository tree (if asked by the filtering). The CMIS data are carried by the ObjectData object.

      • browseParentsOfObject

        protected List<org.apache.chemistry.opencmis.commons.data.ObjectParentData> browseParentsOfObject​(LocalizedResource object,
                                                                                                  Filtering filtering)
        Description copied from class: AbstractCmisObjectsTreeWalker
        Browses for the parents in the CMIS objects tree of the specified Silverpeas object. In a CMIS objects tree, a child can have direct one or several parents. This method returns all of them. However, as the browsing of the CMIS objects tree depends on the type of its node and hence on the type of the objects in Silverpeas, the browsing is delegated to the walker that knows how to handle such a Silverpeas object.
        Specified by:
        browseParentsOfObject in class AbstractCmisObjectsTreeWalker
        Parameters:
        object - an identifiable object in Silverpeas.
        filtering - the filtering rules to apply on the CMIS data to return.
        Returns:
        a list of ObjectParentData elements, each of them being a wrapper of an ObjectData instance with the path of the specified object relative to this parent. The CMIS data are carried by the ObjectData object. If the specified object isn't file-able or it is the root folder (the virtual root space in Silverpeas), then an empty list is returned.