Package com.priint.pubserver.comet.bridge.contextrule

Interface DocumentContextRuleLocal

  • public interface DocumentContextRuleLocal
    The Interface DocumentContextRuleLocal.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String MAPPED_NAME
      The Constant MAPPED_NAME: "com.priint.pubserver.comet.bridge.contextrule.DocumentContextRule"

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String useDocumentVariable​(java.lang.String contextCriteria, java.lang.String name)
      Use a document variable for this context criteria.
      java.lang.String useLayerName​(java.lang.String contextCriteria, java.lang.String format)
      Use the layer name of the output document to determine context criteria.\nThis method takes one parameter, which describes the expected format of the layer name, e.g.

    • Field Detail

      • MAPPED_NAME

        static final java.lang.String MAPPED_NAME
        The Constant MAPPED_NAME: "com.priint.pubserver.comet.bridge.contextrule.DocumentContextRule"
        See Also:
        Constant Field Values

    • Method Detail

      • useDocumentVariable

        java.lang.String useDocumentVariable​(java.lang.String contextCriteria,
                                     java.lang.String name)
                              throws PubServerException
        Use a document variable for this context criteria.
        Parameters:
        contextCriteria - the context criteria
        name - the name
        Returns:
        the string
        Throws:
        PubServerException - the pub server exception

      • useLayerName

        java.lang.String useLayerName​(java.lang.String contextCriteria,
                              java.lang.String format)
        Use the layer name of the output document to determine context criteria.\nThis method takes one parameter, which describes the expected format of the layer name, e.g. \"text#language\".\nWhen applied for the language criteria and the target layer name is \"descriptions#eng\", the context language will be set to English. The same rule applied for country, well or assortment will result in empty values for these criteria.
        Parameters:
        contextCriteria - the context criteria
        format - the format
        Returns:
        the string