Interface Mapper<T>

Type Parameters:
T - type of object to map
All Known Implementing Classes:
AutoMapper

@PublicApi public interface Mapper<T>
Provides support for mapping parts of <T> instances by finding the matching parts and mark them with the same identifier.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Available mapping styles by Mapper
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    map(T item)
    Marks the matching parts of item with the same identifier.
    void
    setKeepMapping(boolean keepMapping)
    Sets if the initial mapping of the given object should be kept or not.
    void
    Sets the mapping style
    void
    setMarkBonds(boolean markResult)
    Sets if the changing bonds should be marked or not.
    void
    setTimeLimit(long timeLimitMilliseconds)
    Sets time limit for calculation.
  • Method Details

    • map

      boolean map(T item)
      Marks the matching parts of item with the same identifier.
      Parameters:
      item - the item to map the parts of
      Returns:
      true if mapping was successful
    • setMappingStyle

      void setMappingStyle(Mapper.MappingStyle style)
      Sets the mapping style
      Parameters:
      style - the mapping style to set
    • setMarkBonds

      void setMarkBonds(boolean markResult)
      Sets if the changing bonds should be marked or not.
      Parameters:
      markResult - if the reaction center should be marked or not
    • setKeepMapping

      void setKeepMapping(boolean keepMapping)
      Sets if the initial mapping of the given object should be kept or not.
      Parameters:
      keepMapping - if the initial mapping of the given object should be kept or not
    • setTimeLimit

      void setTimeLimit(long timeLimitMilliseconds)
      Sets time limit for calculation. Upon elapsing time limit the molecule is mapped with the so far calculated mapping.
      Parameters:
      timeLimitMilliseconds - timeout limit in milliseconds. -1 means disabled.