Package com.day.cq.dam.scene7.api

Interface Scene7AssetFactory

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String TRASH_STATE  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Scene7Asset createAsset​(java.util.Map<java.lang.Object,​java.lang.Object> assetAttributes)
      Creates a new Scene7Asset object
      Scene7Asset parseAsset​(org.w3c.dom.Element element)
      Builds a Scene7Asset object from the Element object received as a parameter
      java.util.List<Scene7Asset> parseAssets​(org.w3c.dom.Document document)
      Processes the Document and builds a list of Scene7Asset objects that the document contains
      Scene7Asset parseMasterAssets​(Scene7Asset asset, org.w3c.dom.Document associatedAssetsDocument)
      Attempts to parse the originator asset for a Scene7 asset that supports sub assets
      Scene7Asset parseSubAssets​(Scene7Asset asset, org.w3c.dom.Document associatedAssetsDocument)
      Attempts to parse the originator asset and sub assets for a Scene7 asset that supports sub assets

    • Method Detail

      • parseAssets

        java.util.List<Scene7Asset> parseAssets​(org.w3c.dom.Document document)
        Processes the Document and builds a list of Scene7Asset objects that the document contains
        Parameters:
        document - Document object containing the Scene7 assets
        Returns:
        a List of Scene7Asset objects

      • parseAsset

        Scene7Asset parseAsset​(org.w3c.dom.Element element)
        Builds a Scene7Asset object from the Element object received as a parameter
        Parameters:
        element - Element object containing a Scene7 asset
        Returns:
        Scene7Asset object

      • parseMasterAssets

        Scene7Asset parseMasterAssets​(Scene7Asset asset,
                              org.w3c.dom.Document associatedAssetsDocument)
        Attempts to parse the originator asset for a Scene7 asset that supports sub assets
        Parameters:
        asset - Scene7Asset asset capable of supporting sub-assets
        associatedAssetsDocument - Document object containing the sub assets and the originator asset
        Returns:
        the Scene7Asset object updated with the parsed sub-assets and the originator asset If the Scene7Asset asset object does not support sub-assets, the object will not be touched

      • parseSubAssets

        Scene7Asset parseSubAssets​(Scene7Asset asset,
                           org.w3c.dom.Document associatedAssetsDocument)
        Attempts to parse the originator asset and sub assets for a Scene7 asset that supports sub assets
        Parameters:
        asset - Scene7Asset asset capable of supporting sub-assets
        associatedAssetsDocument - Document object containing the sub assets and the originator asset
        Returns:
        the Scene7Asset object updated with the parsed sub-assets and the originator asset If the Scene7Asset asset object does not support sub-assets, the object will not be touched

      • createAsset

        Scene7Asset createAsset​(java.util.Map<java.lang.Object,​java.lang.Object> assetAttributes)
        Creates a new Scene7Asset object
        Parameters:
        assetAttributes - a Map object containing the new Scene7 asset's main attributes