Package com.simplicite.util

Class Resource

  • All Implemented Interfaces:
    java.io.Serializable
    public class Resource
extends java.lang.Object
implements java.io.Serializable
    Resource definition
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.Set<java.lang.String> EDITABLE_TYPES
      Editable types
      static java.util.Set<java.lang.String> IMAGE_TYPES
      Editable types
      static java.lang.String TYPE_CSS
      CSS stylesheet type
      static java.lang.String TYPE_FONT
      Font set type
      static java.lang.String TYPE_HTML
      HTML type
      static java.lang.String TYPE_ICON
      Icon type
      static java.lang.String TYPE_IMAGE
      Image type
      static java.lang.String TYPE_JAVASCRIPT
      Javascript type
      static java.lang.String TYPE_JSON
      JSON type
      static java.lang.String TYPE_MD
      Markdown type
      static java.lang.String TYPE_OTHER
      Other type
      static java.lang.String TYPE_PDF
      PDF type
      static java.lang.String TYPE_SET
      File set type
      static java.lang.String TYPE_XML
      XML type

    • Constructor Summary

      Constructors 
      Constructor Description
      Resource​(java.lang.String id, java.lang.String code, java.lang.String type, byte[] data, boolean cached)
      Deprecated. 
      Resource​(java.lang.String id, java.lang.String code, java.lang.String type, byte[] data, boolean cached, java.lang.String revision)
      Deprecated. 
      Resource​(java.lang.String id, java.lang.String code, java.lang.String type, java.lang.String docId, boolean cached)
      Deprecated. 
      Resource​(java.lang.String id, java.lang.String code, java.lang.String type, java.lang.String docId, boolean cached, java.lang.String revision)
      Deprecated. 
      Resource​(java.lang.String id, java.lang.String code, java.lang.String lang, java.lang.String objName, java.lang.String objRowId, java.lang.String type, byte[] data, boolean cached, java.lang.String revision)
      Resource from a content.
      Resource​(java.lang.String id, java.lang.String code, java.lang.String lang, java.lang.String objName, java.lang.String objRowId, java.lang.String type, java.lang.String docId, boolean cached, java.lang.String revision)
      Resource from a document.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addResource​(Resource r)
      Add resource.
      void clearCache()
      Clear cache.
      byte[] getBytes()
      Get resource data (no document).
      boolean getCached()
      Get resource cached flag.
      java.lang.String getCode()
      Get resource code.
      java.lang.String getDocId()
      Get resource document ID.
      DocumentDB getDocument​(Grant g)
      Get resource document.
      byte[] getDocumentContent​(Grant g)
      Get resource document content.
      static java.lang.String getIconContentType​(byte[] b)
      Deprecated, for removal: This API element is subject to removal in a future version. 
      java.lang.String getId()
      Get resource ID.
      java.lang.String getLang()
      Get resource language.
      java.lang.String getObjectName()
      Get resource object name.
      java.lang.String getObjectRowId()
      Get resource object row ID.
      java.io.File getResourceDir()
      Get resource dir (only applicable to file set resources)
      static java.io.File getResourceDir​(java.lang.String object, java.lang.String objId, java.lang.String code, java.lang.String lang)
      Get resource dir (only applicable to file set resources)
      static java.lang.String getResourceId​(java.lang.String object, java.lang.String objId, java.lang.String code, java.lang.String lang)
      Get resource ID.
      java.util.List<Resource> getResources()
      The resource is a set of resources (icons set).
      java.lang.String getRevision()
      Get the resource revision
      java.lang.String getType()
      Get resource type.
      boolean isEditable()
      Is editable type?
      static boolean isEditable​(java.lang.String type)
      Is editable type?
      boolean isImage()
      Is image or icon type?
      static boolean isImage​(java.lang.String type)
      Is image or icon type?
      void setBytes​(byte[] data)
      Set resource data (no document)
      void setCached​(boolean cached)
      Set resource cached flag.
      void setCode​(java.lang.String code)
      Set resource code.
      void setDocId​(java.lang.String docId)
      Set resource document ID.
      void setId​(java.lang.String id)
      Set resource ID.
      void setLang​(java.lang.String lang)
      Set resource language.
      void setObjectName​(java.lang.String name)
      Set resource object name.
      void setObjectRowId​(java.lang.String rowId)
      Set resource object row ID.
      void setType​(java.lang.String type)
      Set resource type.
      java.lang.String toJSON()
      Resource as JSON string.
      org.json.JSONObject toJSONObject()
      Resource as JSON object.
      java.lang.String toString()
      Resource as JSON string.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • TYPE_CSS

        public static final java.lang.String TYPE_CSS
        CSS stylesheet type
        See Also:
        Constant Field Values

      • TYPE_JAVASCRIPT

        public static final java.lang.String TYPE_JAVASCRIPT
        Javascript type
        See Also:
        Constant Field Values

      • TYPE_FONT

        public static final java.lang.String TYPE_FONT
        Font set type
        See Also:
        Constant Field Values

      • IMAGE_TYPES

        public static final java.util.Set<java.lang.String> IMAGE_TYPES
        Editable types

      • EDITABLE_TYPES

        public static final java.util.Set<java.lang.String> EDITABLE_TYPES
        Editable types

    • Constructor Detail

      • Resource

        @Deprecated(forRemoval=false,
            since="5")
public Resource​(java.lang.String id,
                java.lang.String code,
                java.lang.String type,
                java.lang.String docId,
                boolean cached)
        Deprecated.

      • Resource

        @Deprecated(forRemoval=false,
            since="5")
public Resource​(java.lang.String id,
                java.lang.String code,
                java.lang.String type,
                java.lang.String docId,
                boolean cached,
                java.lang.String revision)
        Deprecated.

      • Resource

        public Resource​(java.lang.String id,
                java.lang.String code,
                java.lang.String lang,
                java.lang.String objName,
                java.lang.String objRowId,
                java.lang.String type,
                java.lang.String docId,
                boolean cached,
                java.lang.String revision)
        Resource from a document.
        Parameters:
        id - Resource ID
        code - Code
        lang - Language
        objName - Object name
        objRowId - Object row ID
        type - Type
        docId - Document ID
        cached - Cached?
        revision - Revision for caching

      • Resource

        @Deprecated(forRemoval=false,
            since="5")
public Resource​(java.lang.String id,
                java.lang.String code,
                java.lang.String type,
                byte[] data,
                boolean cached)
        Deprecated.

      • Resource

        @Deprecated(forRemoval=false,
            since="5")
public Resource​(java.lang.String id,
                java.lang.String code,
                java.lang.String type,
                byte[] data,
                boolean cached,
                java.lang.String revision)
        Deprecated.

      • Resource

        public Resource​(java.lang.String id,
                java.lang.String code,
                java.lang.String lang,
                java.lang.String objName,
                java.lang.String objRowId,
                java.lang.String type,
                byte[] data,
                boolean cached,
                java.lang.String revision)
        Resource from a content.
        Parameters:
        id - Resource ID
        code - Code
        lang - Language
        objName - Object name
        objRowId - Object row ID
        type - Type
        data - Data
        cached - Cached?
        revision - Revision for caching

    • Method Detail

      • setId

        public void setId​(java.lang.String id)
        Set resource ID.
        Parameters:
        id - Resource ID

      • getId

        public java.lang.String getId()
        Get resource ID.
        Returns:
        Resource ID

      • getRevision

        public java.lang.String getRevision()
        Get the resource revision
        Returns:
        Last updated date

      • setCode

        public void setCode​(java.lang.String code)
        Set resource code.
        Parameters:
        code - Code

      • getCode

        public java.lang.String getCode()
        Get resource code.
        Returns:
        Resource code

      • setLang

        public void setLang​(java.lang.String lang)
        Set resource language.
        Parameters:
        lang - Language

      • getLang

        public java.lang.String getLang()
        Get resource language.
        Returns:
        Resource language

      • setType

        public void setType​(java.lang.String type)
        Set resource type.
        Parameters:
        type - Resource type

      • getType

        public java.lang.String getType()
        Get resource type.
        Returns:
        Resource type

      • setObjectName

        public void setObjectName​(java.lang.String name)
        Set resource object name.
        Parameters:
        name - Resource object name

      • getObjectName

        public java.lang.String getObjectName()
        Get resource object name.
        Returns:
        Resource object name

      • setObjectRowId

        public void setObjectRowId​(java.lang.String rowId)
        Set resource object row ID.
        Parameters:
        rowId - Resource object row ID

      • getObjectRowId

        public java.lang.String getObjectRowId()
        Get resource object row ID.
        Returns:
        Resource object row ID

      • setDocId

        public void setDocId​(java.lang.String docId)
        Set resource document ID.
        Parameters:
        docId - Document ID

      • getDocId

        public java.lang.String getDocId()
        Get resource document ID.
        Returns:
        Document ID

      • setCached

        public void setCached​(boolean cached)
        Set resource cached flag.
        Parameters:
        cached - Cached?

      • getCached

        public boolean getCached()
        Get resource cached flag.
        Returns:
        True if resource is cached

      • getBytes

        public byte[] getBytes()
        Get resource data (no document).
        Returns:
        Resource data

      • setBytes

        public void setBytes​(byte[] data)
        Set resource data (no document)
        Parameters:
        data - Resource data

      • getResources

        public java.util.List<Resource> getResources()
        The resource is a set of resources (icons set).
        Returns:
        List of resources

      • addResource

        public void addResource​(Resource r)
        Add resource.
        Parameters:
        r - Resource

      • clearCache

        public void clearCache()
        Clear cache.

      • getDocument

        public DocumentDB getDocument​(Grant g)
        Get resource document.
        Parameters:
        g - Grant
        Returns:
        Document

      • getIconContentType

        @Deprecated(forRemoval=true,
            since="5")
public static java.lang.String getIconContentType​(byte[] b)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getDocumentContent

        public byte[] getDocumentContent​(Grant g)
        Get resource document content.
        Parameters:
        g - Grant
        Returns:
        Document content

      • getResourceId

        public static java.lang.String getResourceId​(java.lang.String object,
                                             java.lang.String objId,
                                             java.lang.String code,
                                             java.lang.String lang)
        Get resource ID.
        Parameters:
        object - Object name (one of Dispsition, ObjectInternal, BPMProcess, ObjectExternal)
        objId - Object row ID
        code - Resource code
        lang - Language (defaults to Globals.LANG_ANY)
        Returns:
        Resource ID

      • getResourceDir

        public java.io.File getResourceDir()
        Get resource dir (only applicable to file set resources)
        Returns:
        Resource dir

      • getResourceDir

        public static java.io.File getResourceDir​(java.lang.String object,
                                          java.lang.String objId,
                                          java.lang.String code,
                                          java.lang.String lang)
        Get resource dir (only applicable to file set resources)
        Parameters:
        object - Object name (one of Dispsition, ObjectInternal, BPMProcess, ObjectExternal)
        objId - Object row ID
        code - Resource code
        lang - Language (defaults to Globals.LANG_ANY)
        Returns:
        Resource dir

      • isImage

        public static boolean isImage​(java.lang.String type)
        Is image or icon type?
        Parameters:
        type - Type
        Returns:
        True if image or icon

      • isImage

        public boolean isImage()
        Is image or icon type?
        Returns:
        True if image or icon

      • isEditable

        public static boolean isEditable​(java.lang.String type)
        Is editable type?
        Parameters:
        type - Type
        Returns:
        True if editable

      • isEditable

        public boolean isEditable()
        Is editable type?
        Returns:
        True if editable

      • toJSONObject

        public org.json.JSONObject toJSONObject()
        Resource as JSON object.
        Returns:
        JSON object

      • toJSON

        public java.lang.String toJSON()
        Resource as JSON string.
        Returns:
        JSON string

      • toString

        public java.lang.String toString()
        Resource as JSON string.
        Same as toJSON.
        Overrides:
        toString in class java.lang.Object
        Returns:
        JSON string