Class Type


  • public class Type
    extends java.lang.Object
    Configuration object for displaying a class
    Author:
    Andrew Varley, Thomas Riley
    • Constructor Detail

      • Type

        public Type()
    • Method Detail

      • getLabel

        public java.lang.String getLabel()
        Get the label property's value.
        Returns:
        The value of this property.
      • setLabel

        public void setLabel​(java.lang.String label)
        Set the label property.
        Parameters:
        label - the new value for this property.
      • getDisplayName

        public java.lang.String getDisplayName()
        Returns:
        the display name for this type.
      • getFormattedClassName

        public java.lang.String getFormattedClassName()
        Returns:
        the formatted class name for this type
      • getFormattedClassName

        public static java.lang.String getFormattedClassName​(java.lang.String nameOfClass)
        Parameters:
        nameOfClass - the specific class name
        Returns:
        the formatted class name for a specific class
      • setClassName

        public void setClassName​(java.lang.String className)
        Set the unqualified class name for this Type (from fully-qualified)
        Parameters:
        className - the name of the Type
      • getClassName

        public java.lang.String getClassName()
        Get the class name
        Returns:
        the name
      • getUnqualifiedClassName

        public java.lang.String getUnqualifiedClassName()
        Returns:
        The unqualified name of the class this type configures.
      • addFieldConfig

        public void addFieldConfig​(FieldConfig df)
        Add a FieldConfig for this Type
        Parameters:
        df - the FieldConfig to add
      • getFieldConfigs

        public java.util.Collection<FieldConfig> getFieldConfigs()
        Get the List of FieldConfig objects
        Returns:
        the List of FieldConfig objects
      • getFieldConfigMap

        public java.util.Map<java.lang.String,​FieldConfig> getFieldConfigMap()
        Return a Map from FieldConfig.fieldName to FieldConfig objects.
        Returns:
        the FieldConfig Map
      • getFieldConfig

        public FieldConfig getFieldConfig​(java.lang.String fieldName)
        Return a FieldConfig for a particular field if it has been specified, otherwise return null
        Parameters:
        fieldName - the field to look up config for
        Returns:
        the FieldConfig or null
      • addLongDisplayer

        public void addLongDisplayer​(Displayer disp)
        Add a long displayer for this Type
        Parameters:
        disp - the Displayer to add
      • addHeaderConfigTitle

        public void addHeaderConfigTitle​(HeaderConfigTitle headerConfig)
        Add a header configuration, used from WebConfig
        Parameters:
        headerConfig - lalala
      • getHeaderConfigTitle

        public HeaderConfigTitle getHeaderConfigTitle()
        Returns:
        HeaderConfigTitle
      • addHeaderConfigLink

        public void addHeaderConfigLink​(HeaderConfigLink headerConfig)
        Add a header configuration, used from WebConfig
        Parameters:
        headerConfig - lalala
      • getHeaderConfigLink

        public HeaderConfigLink getHeaderConfigLink()
        Returns:
        HeaderConfigLink
      • addInlineList

        public void addInlineList​(InlineListConfig listConfig)
        Add an InlineList for this object, used from WebConfig
        Parameters:
        listConfig - The list to add.
      • addBagDisplayer

        public void addBagDisplayer​(Displayer disp)
        Add a bag displayer for this Type
        Parameters:
        disp - the Displayer to add
      • getWidgets

        public java.util.LinkedList<WidgetConfig> getWidgets()
        Returns:
        the widgets
      • setWidgets

        public void setWidgets​(java.util.LinkedList widgets)
        Parameters:
        widgets - the widgets to set
      • addWidget

        public void addWidget​(WidgetConfig widget)
        Add a widget to the Type
        Parameters:
        widget - a widget
      • setTableDisplayer

        public void setTableDisplayer​(Displayer disp)
        Set the table displayer for this Type
        Parameters:
        disp - the Displayer
      • getLongDisplayers

        public java.util.Set<? extends java.lang.Object> getLongDisplayers()
        Get the List of long Displayers
        Returns:
        the List of long Displayers
      • getInlineListConfig

        public java.util.List<InlineListConfig> getInlineListConfig()
        Returns:
        inline lists
      • getBagDisplayers

        public java.util.Set<? extends java.lang.Object> getBagDisplayers()
        Get the List of bag Displayers
        Returns:
        the List of bag Displayers
      • getTableDisplayer

        public Displayer getTableDisplayer()
        Get the table Displayer
        Returns:
        the table Displayer
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the Object to compare with
        Returns:
        true if this is equal to obj
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hashCode for this Type object
      • toString

        public java.lang.String toString()
        Return an XML String of this Type object
        Overrides:
        toString in class java.lang.Object
        Returns:
        a String version of this WebConfig object
      • getAspectDisplayers

        public java.util.Map<java.lang.String,​java.util.List<Displayer>> getAspectDisplayers()
        Returns:
        return map from aspect name to list of long displayer
      • setAspectDisplayers

        public void setAspectDisplayers​(java.util.Map<java.lang.String,​java.util.List<Displayer>> aspectDisplayers)
        Parameters:
        aspectDisplayers - The aspectDisplayers to set.
      • getMainTitles

        public java.lang.String getMainTitles()
        Returns:
        null
        See Also:
        getter for WebConfig to work
      • getSubTitles

        public java.lang.String getSubTitles()
        Returns:
        null
        See Also:
        getter for WebConfig to work