Class StreamConfiguration

java.lang.Object
de.hybris.deltadetection.StreamConfiguration
All Implemented Interfaces:
BatchCreationData, Serializable

public class StreamConfiguration extends Object implements BatchCreationData, Serializable
Allows to define which items should be included into the stream.
See Also:
  • Constructor Details

    • StreamConfiguration

      protected StreamConfiguration(String streamId)
      Constructs the configuration
      Parameters:
      streamId - required stream identifier
      Throws:
      NullPointerException - if streamId is null
  • Method Details

    • buildFor

      public static StreamConfiguration buildFor(String streamId)
    • withItemSelector

      public StreamConfiguration withItemSelector(String itemSelector)
      Allows to set selector for given stream. Think of a selector as a part of a where clause of the flexible search query.
      Parameters:
      itemSelector - selector to use by the stream
      Returns:
      the same configuration object
    • withItemTypeCode

      public StreamConfiguration withItemTypeCode(String itemTypeCode)
    • withDataHubColumns

      public StreamConfiguration withDataHubColumns(String dataHubColumns)
    • withImpExHeader

      public StreamConfiguration withImpExHeader(String impExHeader)
    • withSyncType

      public StreamConfiguration withSyncType(String syncType)
    • withParameters

      public StreamConfiguration withParameters(Map<String,Object> parameters)
      Allows to provide parameters for change detection query
      Parameters:
      parameters - parameters which will be passed to final query
      Returns:
      the same configuration object
      Throws:
      NullPointerException - if parameters is null
    • withExcludedTypeCodes

      public StreamConfiguration withExcludedTypeCodes(Set<ComposedTypeModel> excludedTypeCodes)
    • withVersionValue

      public StreamConfiguration withVersionValue(String versionValue)
      Allows to specify a version value used to detect changes in the stream. This value will be used in select clause of the flexible search query.
      Parameters:
      versionValue -
      Returns:
      the same configuration object
    • withDataHubType

      public StreamConfiguration withDataHubType(String dataHubType)
    • getStreamId

      public String getStreamId()
      Returns stream identifier
      Returns:
      stream identifier
    • getParameters

      public Map<String,Object> getParameters()
      Returns parameters to use in the final query
      Returns:
      parameters
    • getItemSelector

      public String getItemSelector()
      Returns item selector which will be used to select items
      Returns:
      item selector
    • getVersionValue

      public String getVersionValue()
      Returns version value used by stream
      Returns:
      version value
    • getExcludedTypeCodes

      public Set<String> getExcludedTypeCodes()
      Returns excluded type codes.
      Returns:
      set of excluded type codes
    • getItemTypeCode

      public String getItemTypeCode()
    • getDataHubType

      public String getDataHubType()
    • getImpExHeader

      public String getImpExHeader()
    • getDataHubColumns

      public String getDataHubColumns()
    • getSyncType

      public String getSyncType()