Package org.opencms.ade.containerpage

Class CmsTypeAnalyzer.State

java.lang.Object

org.opencms.ade.containerpage.CmsTypeAnalyzer.State

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

CmsTypeAnalyzer

public static class CmsTypeAnalyzer.State
extends java.lang.Object
implements java.io.Serializable

Represents all data collected by the CmsTypeAnalyzer class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Set<java.lang.String>	m_excludedContainers	The set of containers to exclude.
protected java.util.Map<CmsUUID,CmsTypeAnalyzer.FormatterBean>	m_formatters	The formatters.
protected java.util.Map<CmsUUID,CmsTypeAnalyzer.ResourceBean>	m_pages	The pages.
protected java.lang.String	m_path	The path.
protected java.lang.String	m_siteRoot	The site root.
boolean	m_skipDetailOnly	True if detail only contents are skipped.
java.lang.String	m_templateRegex	The template regex.
protected java.util.Map<java.lang.String,CmsTypeAnalyzer.TypeBean>	m_types	The types.
protected java.util.Map<java.lang.String,com.google.common.collect.Multimap<CmsUUID,CmsUUID>>	m_typeUsage	The type usage.

Constructor Summary

Constructors

Constructor	Description
State()

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getExcludedContainers()	Gets the container names to exclude.
java.util.Map<CmsUUID,CmsTypeAnalyzer.FormatterBean>	getFormatters()	Gets the formatters.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getFunctionUsages()	Gets the (legacy) dynamic function usages.
java.util.Map<CmsUUID,CmsTypeAnalyzer.ResourceBean>	getPages()	Gets the pages.
java.util.List<java.lang.String>	getPages(java.lang.String type, CmsUUID formatter)	Gets the pages.
java.lang.String	getPath()	Gets the path.
static long	getSerialversionuid()
java.lang.String	getSiteRoot()	Gets the site root.
java.util.List<CmsTypeAnalyzer.FormatterBean>	getSortedFormatters(java.lang.String type)	Gets the sorted formatters.
java.lang.String	getTemplateRegex()
java.util.Map<java.lang.String,CmsTypeAnalyzer.TypeBean>	getTypes()	Gets the types.
java.util.Map<java.lang.String,com.google.common.collect.Multimap<CmsUUID,CmsUUID>>	getTypeUsage()	Gets the type usage.
boolean	isSkipDetailOnly()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_typeUsage

protected java.util.Map<java.lang.String,com.google.common.collect.Multimap<CmsUUID,CmsUUID>> m_typeUsage

The type usage.

m_formatters

protected java.util.Map<CmsUUID,CmsTypeAnalyzer.FormatterBean> m_formatters

The formatters.

m_pages

protected java.util.Map<CmsUUID,CmsTypeAnalyzer.ResourceBean> m_pages

The pages.

m_types

protected java.util.Map<java.lang.String,CmsTypeAnalyzer.TypeBean> m_types

The types.

m_path

protected java.lang.String m_path

The path.

m_siteRoot

protected java.lang.String m_siteRoot

The site root.

m_excludedContainers

protected java.util.Set<java.lang.String> m_excludedContainers

The set of containers to exclude.

m_skipDetailOnly

public boolean m_skipDetailOnly

True if detail only contents are skipped.

m_templateRegex

public java.lang.String m_templateRegex

The template regex.

Constructor Detail

State

public State()

Method Detail

getSerialversionuid

public static long getSerialversionuid()

getExcludedContainers

public java.util.Set<java.lang.String> getExcludedContainers()

Gets the container names to exclude.

Returns:

the top-level containers to exclude

getFormatters

public java.util.Map<CmsUUID,CmsTypeAnalyzer.FormatterBean> getFormatters()

Gets the formatters.

Returns:

the formatters

getFunctionUsages

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getFunctionUsages()

Gets the (legacy) dynamic function usages.

Returns:

the legacy function usages

getPages

public java.util.Map<CmsUUID,CmsTypeAnalyzer.ResourceBean> getPages()

Gets the pages.

Returns:

the pages

getPages

public java.util.List<java.lang.String> getPages(java.lang.String type,
                                                 CmsUUID formatter)

Gets the pages.

Parameters:

type - the type

formatter - the formatter

Returns:

the pages

getPath

public java.lang.String getPath()

Gets the path.

Returns:

the path

getSiteRoot

public java.lang.String getSiteRoot()

Gets the site root.

Returns:

the site root

getSortedFormatters

public java.util.List<CmsTypeAnalyzer.FormatterBean> getSortedFormatters(java.lang.String type)

Gets the sorted formatters.

Parameters:

type - the type

Returns:

the sorted formatters

getTemplateRegex

public java.lang.String getTemplateRegex()

getTypes

public java.util.Map<java.lang.String,CmsTypeAnalyzer.TypeBean> getTypes()

Gets the types.

Returns:

the types

getTypeUsage

public java.util.Map<java.lang.String,com.google.common.collect.Multimap<CmsUUID,CmsUUID>> getTypeUsage()

Gets the type usage.

Returns:

the type usage

isSkipDetailOnly

public boolean isSkipDetailOnly()