Package org.opencms.acacia.client

Interface I_CmsAttributeHandler

All Known Implementing Classes:
CmsAttributeHandler, CmsRootHandler
public interface I_CmsAttributeHandler
Attribute handler interface.

  • Method Details

    • collectSimplePath

      String collectSimplePath(I_CmsAttributeHandler childHandler)
      Returns the simple path.

      Parameters:
      childHandler - the child attribute handler
      Returns:
      the simple path

    • getAttributeName

      String getAttributeName()
      Returns the attribute name.

      Returns:
      the attribute name

    • getChildHandler

      CmsAttributeHandler getChildHandler(String attributeName, int index)
      Returns the handler for the given attribute at the given index.

      Parameters:
      attributeName - the attribute name
      index - the value index
      Returns:
      the handler

    • getChildHandlerBySimpleName

      CmsAttributeHandler getChildHandlerBySimpleName(String name, int index)
      Returns the child handler by simple name.

      Parameters:
      name - the name
      index - the value index
      Returns:
      the child handler if present

    • insertHandlers

      void insertHandlers(int index)
      Inserts a handler map at the given index.

      Parameters:
      index - the value index

    • removeHandlers

      void removeHandlers(int index)
      Removes the handlers at the given index.

      Parameters:
      index - the value index

    • setHandler

      void setHandler(int index, String attributeName, CmsAttributeHandler handler)
      Sets a child attribute handler.

      Parameters:
      index - the value index
      attributeName - the attribute name
      handler - the handler

    • setHandlerById

      void setHandlerById(String attributeName, CmsAttributeHandler handler)
      Sets the handler by id.

      Parameters:
      attributeName - the attribute name
      handler - the handler