Package net.anotheria.asg.generator.meta

Class MetaModule

  • All Implemented Interfaces:
    IGenerateable
    Direct Known Subclasses:
    MetaFederationModule
    public class MetaModule
extends java.lang.Object
implements IGenerateable
    Representation of a module definition.
    Version:
    $Id: $Id
    Author:
    another

    • Field Detail

      • SHARED

        public static final MetaModule SHARED
        This is a predefined module used to generate package and class names for shared stuff.

      • USER_SETTINGS

        public static final MetaModule USER_SETTINGS
        This is a predefined module used to generate package and class names for user settings stuff.

    • Constructor Detail

      • MetaModule

        public MetaModule()
        Creates a new empty module.

      • MetaModule

        public MetaModule​(java.lang.String name)
        Creates a new module with the given name.
        Parameters:
        name - name of the module.

    • Method Detail

      • addDocument

        public void addDocument​(MetaDocument aDocument)
        Adds a document definition to the module.
        Parameters:
        aDocument - a MetaDocument object.

      • isEnabledByOptions

        public boolean isEnabledByOptions​(java.lang.String key)
        Returns true if an option is enabled. For example 'rmi' is an option which can be enabled.
        Parameters:
        key - a String object.
        Returns:
        true if an option is enabled

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getDocuments

        public java.util.List<MetaDocument> getDocuments()

        Getter for the field documents.

        Returns:
        contained documents

      • getName

        public java.lang.String getName()

        Getter for the field name.

        Returns:
        name of the module

      • getModuleClassName

        public java.lang.String getModuleClassName()

        getModuleClassName.

        Returns:
        the name for the module implementation class in the cms storage

      • getFactoryClassName

        public java.lang.String getFactoryClassName()

        getFactoryClassName.

        Returns:
        the class name of the generated module factory

      • setDocuments

        public void setDocuments​(java.util.List<MetaDocument> list)

        Setter for the field documents.

        Parameters:
        list - a List object.

      • setName

        public void setName​(java.lang.String string)

        Setter for the field name.

        Parameters:
        string - a String object.

      • getId

        public java.lang.String getId()
        Returns the id of the module. Id is basically name.toLowerCase().
        Returns:
        the id of the module

      • getDocumentByName

        public MetaDocument getDocumentByName​(java.lang.String aName)

        getDocumentByName.

        Parameters:
        aName - a String object.
        Returns:
        a MetaDocument object.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getListeners

        public java.util.List<java.lang.String> getListeners()

        Getter for the field listeners.

        Returns:
        a List object.

      • setListeners

        public void setListeners​(java.util.List<java.lang.String> listeners)

        Setter for the field listeners.

        Parameters:
        listeners - a List object.

      • addListener

        public void addListener​(java.lang.String listenerClass)

        addListener.

        Parameters:
        listenerClass - a String object.

      • removeListener

        public void removeListener​(java.lang.String listenerClass)

        removeListener.

        Parameters:
        listenerClass - a String object.

      • getStorageType

        public StorageType getStorageType()

        Getter for the field storageType.

        Returns:
        a StorageType object.

      • setStorageType

        public void setStorageType​(StorageType aStorageType)

        Setter for the field storageType.

        Parameters:
        aStorageType - a StorageType object.

      • getStorageKey

        public java.lang.String getStorageKey()
        Deprecated.
        Noone knows what storagekey does.

        Getter for the field storageKey.

        Returns:
        a String object.

      • setStorageKey

        public void setStorageKey​(java.lang.String aStorageKey)
        Deprecated.
        Noone knows what storagekey does.

        Setter for the field storageKey.

        Parameters:
        aStorageKey - a String object.

      • getModuleParameter

        public ModuleParameter getModuleParameter​(java.lang.String aName)

        getModuleParameter.

        Parameters:
        aName - a String object.
        Returns:
        a ModuleParameter object.

      • isParameterEqual

        public boolean isParameterEqual​(java.lang.String aName,
                                java.lang.String aValue)

        isParameterEqual.

        Parameters:
        aName - a String object.
        aValue - a String object.
        Returns:
        a boolean.

      • setModuleOptions

        public void setModuleOptions​(GenerationOptions someModuleOptions)

        Setter for the field moduleOptions.

        Parameters:
        someModuleOptions - a GenerationOptions object.

      • isContainsAnyMultilingualDocs

        public boolean isContainsAnyMultilingualDocs()

        isContainsAnyMultilingualDocs.

        Returns:
        a boolean.