Class ResponseDomain

  • All Implemented Interfaces:
    IEntityAuditXmlRef

    @Entity
    public class ResponseDomain
    extends AbstractEntityAudit
    CodeList A special form of maintainable that allows a single codelist to be maintained outside of a CodeListScheme.
    QuestionGrid
    Structures the QuestionGrid as an NCube-like structure providing dimension information, labeling options, and response domains attached to one or more cells within the grid.
    QuestionItem
    Structure a single Question which may contain one or more response domains (i.e., a list of valid category responses where if "Other" is indicated a text response can be used to specify the intent of "Other").
    ResponseInMixed
    A structure that provides both the response domain and information on how it should be attached, or related, to other specified response domains in the question.
    Category
    A category (without an attached category) response for a question item.
    Implemented as: Code.Category = Code.codeValue;
    Code
    A coded response (where both codes and their related category value are displayed) for a question item.
    Implemented as: Code.Category = "A_NAME", Code.CodeValue = "A_VALUE"
    Numeric
    A numeric response (the intent is to analyze the response as a number) for a question item.
    Implemented as: Code = NULL; (no category is needed)
    Scale
    A scale response which describes a 1..n dimensional scale of various display types for a question.
    Implemented as: Code.CodeValue = valid values 1..n + control codes (N/A, Refuses, can't answer, don't know etc)
    Text
    A textual response.
    Implemented as: Code = NULL; (no category is needed)
    These to be implemented later
    -DateTime; A date or time response for a question item.
    -Distribution;A distribution response for a question, may only be included in-line.
    -Geographic; A geographic coordinate reading as a response for a question item.
    -GeographicLocationCode; A response domain capturing the name or category of a Geographic Location as a response for a question item, may only be included in-line.
    -GeographicStructureCode;A geographic structure category as a response for a question item, may only be included in-line.
    -Location; A location response (mark on an image, recording, or object) for a question, may only be included in-line.
    -Nominal; A nominal (check off) response for a question grid response, may only be included in-line.
    -Ranking; A ranking response which supports a "ranking" of categories. Generally used within a QuestionGrid, may only be included in-line.
    • Constructor Detail

      • ResponseDomain

        public ResponseDomain()
    • Method Detail

      • getDescription

        public java.lang.String getDescription()
      • setDescription

        public void setDescription​(java.lang.String description)
      • setResponseKind

        public void setResponseKind​(ResponseKind responseKind)
      • setResponseCardinality

        protected void setResponseCardinality​(ResponseCardinality responseCardinality)
      • getDisplayLayout

        public java.lang.String getDisplayLayout()
        Vocabulary for Display layout would suffice with 'Horizontal' (default) vs. Vertical'.
        Returns:
        DisplayLayout
      • setDisplayLayout

        public void setDisplayLayout​(java.lang.String displayLayout)
      • populateCodes

        public void populateCodes()
        this is useful for populating codes before saving to DB
      • getManagedRepresentation

        public Category getManagedRepresentation()
      • getFlatManagedRepresentation

        protected java.util.List<Category> getFlatManagedRepresentation​(Category current)
      • setManagedRepresentation

        public void setManagedRepresentation​(Category managedRepresentation)
      • getCodes

        public java.util.List<Code> getCodes()
      • setCodes

        public void setCodes​(java.util.List<Code> codes)
      • getSchemaId

        public java.util.UUID getSchemaId()
      • setSchemaId

        public void setSchemaId​(java.util.UUID schemaId)