Interface DataMappingToStringLocal


  • public interface DataMappingToStringLocal
    The interface Data mapping.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String MAPPED_NAME
      The constant MAPPED_NAME.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> bucketLabelToString​(java.util.List<Bucket> buckets)
      Map the label of the first entry of a bucket list to a string
      java.util.List<java.lang.String> bucketPropertyToString​(java.util.List<Bucket> buckets, java.lang.String propertyName)
      Gets an arbitrary property from a bucket
      java.util.List<java.lang.String> cordPropertyToString​(java.util.List<Cord> cords, java.lang.String propertyName)
      Gets an arbitrary property from a cord
      java.util.List<java.lang.String> firstMediaAssetToFilePath​(java.util.List<MediaAsset> mediaAssets)
      Get the path of the first media object from the first media asset
      java.util.List<java.lang.String> firstMediaAssetToFileUrl​(java.util.List<MediaAsset> mediaAssets)
      Get the URL of the first media object from the first media asset
      java.util.List<java.lang.String> firstTextOfAncestorBucketsToString​(java.lang.String sessionId, java.util.List<Bucket> descendants, java.lang.String entityModelName, java.lang.String ancestorEntityId, java.lang.String textIdentifier, int level, Context context, java.lang.String searchStr)
      Go back n levels in bucket tree and map the specified text of that bucket to a String List.
      java.util.List<java.lang.String> firstTextToString​(java.util.List<Text> texts)
      Map the first entry of a text list to a String list
      java.util.List<java.lang.String> keyValuePropertyToString​(java.util.List<KeyValue> keyValues, java.lang.String propertyName)
      Gets an arbitrary property from a keyValue
      java.util.List<java.lang.String> keyValuesToStrings​(java.util.List<KeyValue> keyValues)
      Map the first value of a key value list to a String list
      java.util.List<java.lang.String> lastMediaAssetToFilePath​(java.util.List<MediaAsset> mediaAssets)
      Get the path of the last media object from the last media asset
      java.util.List<java.lang.String> lastMediaAssetToFileUrl​(java.util.List<MediaAsset> mediaAssets)
      Get the URL of the first media object from the first media asset
      java.util.List<java.lang.String> lastTextToString​(java.util.List<Text> texts)
      Map the last entry of a text list to a String list
      java.util.List<java.lang.String> mediaAssetListToFilePath​(java.util.List<MediaAsset> mediaAssets, java.lang.String record, java.lang.String type, java.lang.String media)
      Map media assets to file paths
      java.util.List<java.lang.String> mediaAssetListToFileUrl​(java.util.List<MediaAsset> mediaAssets, java.lang.String record, java.lang.String type, java.lang.String media)
      Map media assets to URLs
      java.util.List<java.lang.String> mediaAssetPropertyToString​(java.util.List<MediaAsset> mediaAssets, java.lang.String propertyName)
      Gets an arbitrary property from a mediaAsset
      java.util.List<java.lang.String> nthPriceToString​(java.util.List<Price> prices, java.lang.String designator, int nth)
      Map the field selected by designator of the first price to a string
      java.util.List<java.lang.String> planningPropertyToString​(java.util.List<Planning> plannings, java.lang.String propertyName)
      Gets an arbitrary property from a planning
      java.util.List<java.lang.String> pricePropertyToString​(java.util.List<Price> prices, java.lang.String propertyName)
      Gets an arbitrary property from a price
      java.util.List<java.lang.String> tableDataPropertyToString​(java.util.List<TableData> tableDatas, java.lang.String propertyName)
      Gets an arbitrary property from a tableData
      java.util.List<java.lang.String> textListToStrings​(java.util.List<Text> texts, java.lang.String range, java.lang.String delimiter, java.lang.String prefix, java.lang.String suffix)
      Map multiple texts to strings
      java.util.List<java.lang.String> textPropertyToString​(java.util.List<Text> texts, java.lang.String propertyName)
      Gets an arbitrary property from a text
      java.util.List<java.lang.String> textsToStrings​(java.util.List<Text> texts)
      Map the last entry of a text list to a String list
      java.util.List<java.lang.String> textToString​(java.util.List<Text> texts, int nth)
      Map the nth entry of a text list to a string
      java.util.List<java.lang.String> valuesByKeyToStrings​(java.util.List<KeyValue> keyValues, java.lang.String key)
      Map all values associated to the given key to a String list
    • Field Detail

      • MAPPED_NAME

        static final java.lang.String MAPPED_NAME
        The constant MAPPED_NAME.
        See Also:
        Constant Field Values
    • Method Detail

      • bucketLabelToString

        java.util.List<java.lang.String> bucketLabelToString​(java.util.List<Bucket> buckets)
                                                      throws PubServerException
        Map the label of the first entry of a bucket list to a string
        Parameters:
        buckets - the buckets
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • firstMediaAssetToFilePath

        java.util.List<java.lang.String> firstMediaAssetToFilePath​(java.util.List<MediaAsset> mediaAssets)
                                                            throws PubServerException
        Get the path of the first media object from the first media asset
        Parameters:
        mediaAssets - the media assets
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • firstMediaAssetToFileUrl

        java.util.List<java.lang.String> firstMediaAssetToFileUrl​(java.util.List<MediaAsset> mediaAssets)
                                                           throws PubServerException
        Get the URL of the first media object from the first media asset
        Parameters:
        mediaAssets - the result set of the query return list of string, the first element is the URL
        Returns:
        the list
        Throws:
        PubServerException - the pub server exception
      • firstTextOfAncestorBucketsToString

        java.util.List<java.lang.String> firstTextOfAncestorBucketsToString​(java.lang.String sessionId,
                                                                            java.util.List<Bucket> descendants,
                                                                            java.lang.String entityModelName,
                                                                            java.lang.String ancestorEntityId,
                                                                            java.lang.String textIdentifier,
                                                                            int level,
                                                                            Context context,
                                                                            java.lang.String searchStr)
                                                                     throws PubServerException
        Go back n levels in bucket tree and map the specified text of that bucket to a String List.
        Parameters:
        sessionId - the session id
        descendants - the descendants
        entityModelName - the entity model name
        ancestorEntityId - the ancestor entity id
        textIdentifier - the text identifier
        level - the level
        context - the context
        searchStr - the search str
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • firstTextToString

        java.util.List<java.lang.String> firstTextToString​(java.util.List<Text> texts)
                                                    throws PubServerException
        Map the first entry of a text list to a String list
        Parameters:
        texts - the texts
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • keyValuesToStrings

        java.util.List<java.lang.String> keyValuesToStrings​(java.util.List<KeyValue> keyValues)
                                                     throws PubServerException
        Map the first value of a key value list to a String list
        Parameters:
        keyValues - the key values
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • lastMediaAssetToFilePath

        java.util.List<java.lang.String> lastMediaAssetToFilePath​(java.util.List<MediaAsset> mediaAssets)
                                                           throws PubServerException
        Get the path of the last media object from the last media asset
        Parameters:
        mediaAssets - the media assets
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • lastMediaAssetToFileUrl

        java.util.List<java.lang.String> lastMediaAssetToFileUrl​(java.util.List<MediaAsset> mediaAssets)
                                                          throws PubServerException
        Get the URL of the first media object from the first media asset
        Parameters:
        mediaAssets - the resultset of the queryreturn list of string, the first element is the url
        Returns:
        the list
        Throws:
        PubServerException - the pub server exception
      • lastTextToString

        java.util.List<java.lang.String> lastTextToString​(java.util.List<Text> texts)
                                                   throws PubServerException
        Map the last entry of a text list to a String list
        Parameters:
        texts - the texts
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • mediaAssetListToFilePath

        java.util.List<java.lang.String> mediaAssetListToFilePath​(java.util.List<MediaAsset> mediaAssets,
                                                                  java.lang.String record,
                                                                  java.lang.String type,
                                                                  java.lang.String media)
                                                           throws PubServerException
        Map media assets to file paths
        Parameters:
        mediaAssets - the media assets
        record - the record
        type - the type
        media - the media
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • mediaAssetListToFileUrl

        java.util.List<java.lang.String> mediaAssetListToFileUrl​(java.util.List<MediaAsset> mediaAssets,
                                                                 java.lang.String record,
                                                                 java.lang.String type,
                                                                 java.lang.String media)
                                                          throws PubServerException
        Map media assets to URLs
        Parameters:
        mediaAssets - the media assets
        record - the record
        type - the type
        media - the media
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • nthPriceToString

        java.util.List<java.lang.String> nthPriceToString​(java.util.List<Price> prices,
                                                          java.lang.String designator,
                                                          int nth)
                                                   throws PubServerException
        Map the field selected by designator of the first price to a string
        Parameters:
        prices - the prices
        designator - the designator
        nth - the nth
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • textListToStrings

        java.util.List<java.lang.String> textListToStrings​(java.util.List<Text> texts,
                                                           java.lang.String range,
                                                           java.lang.String delimiter,
                                                           java.lang.String prefix,
                                                           java.lang.String suffix)
                                                    throws PubServerException
        Map multiple texts to strings
        Parameters:
        texts - the texts
        range - the range
        delimiter - the delimiter
        prefix - the prefix
        suffix - the suffix
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • textsToStrings

        java.util.List<java.lang.String> textsToStrings​(java.util.List<Text> texts)
                                                 throws PubServerException
        Map the last entry of a text list to a String list
        Parameters:
        texts - the texts
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • textToString

        java.util.List<java.lang.String> textToString​(java.util.List<Text> texts,
                                                      int nth)
                                               throws PubServerException
        Map the nth entry of a text list to a string
        Parameters:
        texts - the texts
        nth - the nth
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • valuesByKeyToStrings

        java.util.List<java.lang.String> valuesByKeyToStrings​(java.util.List<KeyValue> keyValues,
                                                              java.lang.String key)
                                                       throws PubServerException
        Map all values associated to the given key to a String list
        Parameters:
        keyValues - the key values
        key - the key
        Returns:
        list
        Throws:
        PubServerException - the pub server exception
      • bucketPropertyToString

        java.util.List<java.lang.String> bucketPropertyToString​(java.util.List<Bucket> buckets,
                                                                java.lang.String propertyName)
                                                         throws PubServerException

        Gets an arbitrary property from a bucket

        Parameters:
        buckets - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception
      • cordPropertyToString

        java.util.List<java.lang.String> cordPropertyToString​(java.util.List<Cord> cords,
                                                              java.lang.String propertyName)
                                                       throws PubServerException

        Gets an arbitrary property from a cord

        Parameters:
        cords - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception
      • keyValuePropertyToString

        java.util.List<java.lang.String> keyValuePropertyToString​(java.util.List<KeyValue> keyValues,
                                                                  java.lang.String propertyName)
                                                           throws PubServerException

        Gets an arbitrary property from a keyValue

        Parameters:
        keyValues - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception
      • mediaAssetPropertyToString

        java.util.List<java.lang.String> mediaAssetPropertyToString​(java.util.List<MediaAsset> mediaAssets,
                                                                    java.lang.String propertyName)
                                                             throws PubServerException

        Gets an arbitrary property from a mediaAsset

        Parameters:
        mediaAssets - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception
      • planningPropertyToString

        java.util.List<java.lang.String> planningPropertyToString​(java.util.List<Planning> plannings,
                                                                  java.lang.String propertyName)
                                                           throws PubServerException

        Gets an arbitrary property from a planning

        Parameters:
        plannings - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception
      • pricePropertyToString

        java.util.List<java.lang.String> pricePropertyToString​(java.util.List<Price> prices,
                                                               java.lang.String propertyName)
                                                        throws PubServerException

        Gets an arbitrary property from a price

        Parameters:
        prices - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception
      • textPropertyToString

        java.util.List<java.lang.String> textPropertyToString​(java.util.List<Text> texts,
                                                              java.lang.String propertyName)
                                                       throws PubServerException

        Gets an arbitrary property from a text

        Parameters:
        texts - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception
      • tableDataPropertyToString

        java.util.List<java.lang.String> tableDataPropertyToString​(java.util.List<TableData> tableDatas,
                                                                   java.lang.String propertyName)
                                                            throws PubServerException

        Gets an arbitrary property from a tableData

        Parameters:
        tableDatas - result from data query
        propertyName - name of the property
        Returns:
        list of the requested properties
        Throws:
        PubServerException - the pub server exception