Class MaisDoc

java.lang.Object
org.x4o.maisdoc.model.MaisDoc
public class MaisDoc extends Object
ApiDoc holds all config and data to write a full api doc structure.
Version:
1.0 May 12, 2013
Author:
Willem Cazander

  • Constructor Details

    • MaisDoc

      public MaisDoc()

  • Method Details

    • checkModel

      public void checkModel() throws NullPointerException, IllegalArgumentException
      Throws:
      NullPointerException
      IllegalArgumentException

    • findConceptByClass

      public MaisDocConcept findConceptByClass(Class<?> objClass)

    • findConceptChildByNode

      public MaisDocConcept findConceptChildByNode(MaisDocNode node)

    • getRemoteClasses

      public List<MaisDocRemoteClass> getRemoteClasses()

    • addRemoteClass

      public void addRemoteClass(MaisDocRemoteClass remoteClass)

    • removeRemoteClass

      public void removeRemoteClass(MaisDocRemoteClass remoteClass)

    • getAnnotatedClasses

      public List<Class<?>> getAnnotatedClasses()

    • removeAnnotatedClasses

      public void removeAnnotatedClasses(Class<?> annotatedClass)

    • addAnnotatedClasses

      public void addAnnotatedClasses(Class<?> annotatedClass)

    • getDataConfigurators

      public List<MaisDocNodeDataConfigurator> getDataConfigurators()

    • removeDataConfigurator

      public void removeDataConfigurator(MaisDocNodeDataConfigurator conf)

    • addDataConfigurator

      public void addDataConfigurator(MaisDocNodeDataConfigurator conf)

    • addNodeBodyWriter

      public MaisDocNodeWriter addNodeBodyWriter(MaisDocNodeWriter writer)

    • removeNodeBodyWriter

      public boolean removeNodeBodyWriter(MaisDocNodeWriter writer)

    • getNodeBodyWriters

      public List<MaisDocNodeWriter> getNodeBodyWriters()

    • addConcept

      public MaisDocConcept addConcept(MaisDocConcept concept)

    • removeConcept

      public boolean removeConcept(MaisDocConcept concept)

    • getConcepts

      public List<MaisDocConcept> getConcepts()

    • addMetaKeyword

      public void addMetaKeyword(String keyword)

    • addMetaKeywordAll

      public void addMetaKeywordAll(Collection<String> keywords)

    • removeMetaKeyword

      public boolean removeMetaKeyword(String keyword)

    • getDocKeywords

      public List<String> getDocKeywords()

    • getMetaStyleSheet

      public File getMetaStyleSheet()
      Returns:
      the metaStyleSheet

    • setMetaStyleSheet

      public void setMetaStyleSheet(File metaStyleSheet)
      Parameters:
      metaStyleSheet - the metaStyleSheet to set

    • getMetaStyleSheetThema

      public String getMetaStyleSheetThema()
      Returns:
      the metaStyleSheetThema

    • setMetaStyleSheetThema

      public void setMetaStyleSheetThema(String metaStyleSheetThema)
      Parameters:
      metaStyleSheetThema - the metaStyleSheetThema to set

    • getDocCopyright

      public String getDocCopyright()
      Returns:
      the docCopyright

    • setDocCopyright

      public void setDocCopyright(String docCopyright)
      Parameters:
      docCopyright - the docCopyright to set

    • createDocCopyright

      public void createDocCopyright(String owner)
      Creates default copyright message for owner.
      Parameters:
      owner - The owner of the copyright.

    • createDocCopyright

      public void createDocCopyright(String owner, String year)
      Creates default copyright message for owner and year.
      Parameters:
      owner - The owner of the copyright.
      year - The year of the copyright.

    • getDocAbout

      public String getDocAbout()
      Returns:
      the docAbout

    • setDocAbout

      public void setDocAbout(String docAbout)
      Parameters:
      docAbout - the docAbout to set

    • addDocPage

      public MaisDocPage addDocPage(MaisDocPage page)

    • removeDocPage

      public boolean removeDocPage(MaisDocPage page)

    • getDocPages

      public List<MaisDocPage> getDocPages()

    • findDocPageById

      public MaisDocPage findDocPageById(String docPageId)

    • addTreeNodeClassExclude

      public Class<?> addTreeNodeClassExclude(Class<?> excludeClass)

    • removeTreeNodeClassExclude

      public boolean removeTreeNodeClassExclude(Class<?> excludeClass)

    • getTreeNodeClassExcludes

      public List<Class<?>> getTreeNodeClassExcludes()

    • addTreeNodePageModeClass

      public Class<?> addTreeNodePageModeClass(Class<?> pageModeClass)

    • removeTreeNodePageModeClass

      public boolean removeTreeNodePageModeClass(Class<?> pageModeClass)

    • getTreeNodePageModeClasses

      public List<Class<?>> getTreeNodePageModeClasses()

    • getName

      public String getName()
      Returns:
      the name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getDescription

      public String getDescription()
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - the description to set

    • getRootNodeTreePage

      public MaisDocNode getRootNodeTreePage()
      Returns:
      the rootNodeTreePage

    • setRootNodeTreePage

      public void setRootNodeTreePage(MaisDocNode rootNodeTreePage)
      Parameters:
      rootNodeTreePage - the rootNodeTreePage to set

    • getRootNode

      public MaisDocNode getRootNode()
      Returns:
      the rootNode

    • setRootNode

      public void setRootNode(MaisDocNode rootNode)
      Parameters:
      rootNode - the rootNode to set

    • getFrameNavConceptClass

      public Class<?> getFrameNavConceptClass()
      Returns:
      the frameNavConceptClass

    • setFrameNavConceptClass

      public void setFrameNavConceptClass(Class<?> frameNavConceptClass)
      Parameters:
      frameNavConceptClass - the frameNavConceptClass to set

    • getFrameNavPrintParent

      public Boolean getFrameNavPrintParent()
      Returns:
      the frameNavPrintParent

    • setFrameNavPrintParent

      public void setFrameNavPrintParent(Boolean frameNavPrintParent)
      Parameters:
      frameNavPrintParent - the frameNavPrintParent to set

    • getFrameNavPrintParentParent

      public Boolean getFrameNavPrintParentParent()
      Returns:
      the frameNavPrintParentParent

    • setFrameNavPrintParentParent

      public void setFrameNavPrintParentParent(Boolean frameNavPrintParentParent)
      Parameters:
      frameNavPrintParentParent - the frameNavPrintParentParent to set

    • getFrameNavOverviewPrintParent

      public Boolean getFrameNavOverviewPrintParent()
      Returns:
      the frameNavOverviewPrintParent

    • setFrameNavOverviewPrintParent

      public void setFrameNavOverviewPrintParent(Boolean frameNavOverviewPrintParent)
      Parameters:
      frameNavOverviewPrintParent - the frameNavOverviewPrintParent to set

    • getFrameNavPrintParentId

      public Boolean getFrameNavPrintParentId()
      Returns:
      the frameNavPrintParentId

    • setFrameNavPrintParentId

      public void setFrameNavPrintParentId(Boolean frameNavPrintParentId)
      Parameters:
      frameNavPrintParentId - the frameNavPrintParentId to set

    • getNodeData

      public MaisDocNodeData getNodeData()
      Returns:
      the nodeData

    • setNodeData

      public void setNodeData(MaisDocNodeData nodeData)
      Parameters:
      nodeData - the nodeData to set

    • getDocStatsJS

      public String getDocStatsJS()
      Returns:
      the docStatsJS

    • setDocStatsJS

      public void setDocStatsJS(String docStatsJS)
      Parameters:
      docStatsJS - the docStatsJS to set

    • getNoFrameAllName

      public String getNoFrameAllName()
      Returns:
      the noFrameAllName

    • setNoFrameAllName

      public void setNoFrameAllName(String noFrameAllName)
      Parameters:
      noFrameAllName - the noFrameAllName to set

    • getNoFrameAllLink

      public String getNoFrameAllLink()
      Returns:
      the noFrameAllLink

    • setNoFrameAllLink

      public void setNoFrameAllLink(String noFrameAllLink)
      Parameters:
      noFrameAllLink - the noFrameAllLink to set

    • getNoFrameAllTopJS

      public String getNoFrameAllTopJS()
      Returns:
      the noFrameAllTopJS

    • setNoFrameAllTopJS

      public void setNoFrameAllTopJS(String noFrameAllTopJS)
      Parameters:
      noFrameAllTopJS - the noFrameAllTopJS to set

    • getNoFrameAllBottomJS

      public String getNoFrameAllBottomJS()
      Returns:
      the noFrameAllBottomJS

    • setNoFrameAllBottomJS

      public void setNoFrameAllBottomJS(String noFrameAllBottomJS)
      Parameters:
      noFrameAllBottomJS - the noFrameAllBottomJS to set

    • isSkipRootTreePathNode

      public boolean isSkipRootTreePathNode()
      Returns:
      the skipRootTreePathNode

    • setSkipRootTreePathNode

      public void setSkipRootTreePathNode(boolean skipRootTreePathNode)
      Parameters:
      skipRootTreePathNode - the skipRootTreePathNode to set

    • isPrintConceptTitle

      public boolean isPrintConceptTitle()
      Returns:
      the printConceptTitle

    • setPrintConceptTitle

      public void setPrintConceptTitle(boolean printConceptTitle)
      Parameters:
      printConceptTitle - the printConceptTitle to set

    • isPrintConceptPrevNext

      public boolean isPrintConceptPrevNext()
      Returns:
      the printConceptPrevNext

    • setPrintConceptPrevNext

      public void setPrintConceptPrevNext(boolean printConceptPrevNext)
      Parameters:
      printConceptPrevNext - the printConceptPrevNext to set

    • getGroupTypesOrdered

      public List<String> getGroupTypesOrdered()

    • getGroupTypeName

      public String getGroupTypeName(String groupTypeKey)

    • setGroupTypeName

      public void setGroupTypeName(String groupTypeKey, String name, int order)

    • getDocPageSubTitle

      public String getDocPageSubTitle()
      Returns:
      the docPageSubTitle

    • setDocPageSubTitle

      public void setDocPageSubTitle(String docPageSubTitle)
      Parameters:
      docPageSubTitle - the docPageSubTitle to set