Interface NamespaceEncoder

  • All Known Implementing Classes:
    EmptyNamespaceEncoderImpl

    public interface NamespaceEncoder
    This interface is used to encode a namespace into the domain of an object.
    Since:
    MicroStrategy Web 8.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String encodeName​(java.lang.String origName)
      Given a name in our generated content (e.g., a form field), encode it as needed by the application environment.
      java.lang.String encodeResourceURI​(java.lang.String originalURI)
      Given a static URI reference, encode it as needed by the application environment.
      void init​(java.lang.Object parent)
      Initialize this object (supplying the parent object as the only parameter).
    • Method Detail

      • init

        void init​(java.lang.Object parent)
        Initialize this object (supplying the parent object as the only parameter).
        Parameters:
        parent - The parent (enclosing) object that this Namespace Encoder is attached to.
      • encodeResourceURI

        java.lang.String encodeResourceURI​(java.lang.String originalURI)
        Given a static URI reference, encode it as needed by the application environment.
        Parameters:
        originalURI - The original URI for a static resource.
        Returns:
        The encoded URI for the same resource.
      • encodeName

        java.lang.String encodeName​(java.lang.String origName)
        Given a name in our generated content (e.g., a form field), encode it as needed by the application environment.
        Parameters:
        origName - The name of the original object (e.g., FORM field)
        Returns:
        The newly (encoded) name.