Package org.apache.solr.core

Class PluginInfo

java.lang.Object

org.apache.solr.core.PluginInfo

All Implemented Interfaces:

org.apache.solr.common.MapSerializable

public class PluginInfo
extends Object
implements org.apache.solr.common.MapSerializable

An Object which represents a Plugin of any type

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginInfo.ClassName

Field Summary

Fields

Modifier and Type	Field	Description
static String	APPENDS
Map<String,String>	attributes
List<PluginInfo>	children
String	className
PluginInfo.ClassName	cName
static String	DEFAULTS
static PluginInfo	EMPTY_INFO
org.apache.solr.common.util.NamedList<Object>	initArgs
static String	INVARIANTS
String	name
String	pkgName
String	type

Constructor Summary

Constructors

Constructor	Description
PluginInfo(String type, Map<String,Object> map)
PluginInfo(String type, Map<String,String> attrs, org.apache.solr.common.util.NamedList<?> initArgs, List<PluginInfo> children)
PluginInfo(org.apache.solr.common.ConfigNode node, String err, boolean requireName, boolean requireClass)
PluginInfo(Node node, String err, boolean requireName, boolean requireClass)

Method Summary

Modifier and Type	Method	Description
PluginInfo	copy()
PluginInfo	getChild(String type)
List<PluginInfo>	getChildren(String type)	Filter children by type
boolean	isDefault()
boolean	isEnabled()
boolean	isFromSolrConfig()
static PluginInfo.ClassName	parseClassName(String name)	class names can be prefixed with package name e.g: my_package:my.pkg.Class This checks if it is a package name prefixed classname.
Map<String,Object>	toMap(Map<String,Object> map)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

className

public final String className

type

public final String type

pkgName

public final String pkgName

cName

public final PluginInfo.ClassName cName

initArgs

public final org.apache.solr.common.util.NamedList<Object> initArgs

attributes

public final Map<String,String> attributes

children

public final List<PluginInfo> children

EMPTY_INFO

public static final PluginInfo EMPTY_INFO

DEFAULTS

public static final String DEFAULTS

See Also:

Constant Field Values

APPENDS

public static final String APPENDS

See Also:

Constant Field Values

INVARIANTS

public static final String INVARIANTS

See Also:

Constant Field Values

Constructor Detail

PluginInfo

public PluginInfo(String type,
                  Map<String,String> attrs,
                  org.apache.solr.common.util.NamedList<?> initArgs,
                  List<PluginInfo> children)

PluginInfo

public PluginInfo(org.apache.solr.common.ConfigNode node,
                  String err,
                  boolean requireName,
                  boolean requireClass)

PluginInfo

public PluginInfo(Node node,
                  String err,
                  boolean requireName,
                  boolean requireClass)

PluginInfo

public PluginInfo(String type,
                  Map<String,Object> map)

Method Detail

parseClassName

public static PluginInfo.ClassName parseClassName(String name)

class names can be prefixed with package name e.g: my_package:my.pkg.Class This checks if it is a package name prefixed classname. the return value has first = package name and second = class name

toString

public String toString()

Overrides:

toString in class Object

isEnabled

public boolean isEnabled()

isDefault

public boolean isDefault()

getChild

public PluginInfo getChild(String type)

toMap

public Map<String,Object> toMap(Map<String,Object> map)

Specified by:

toMap in interface org.apache.solr.common.MapSerializable

getChildren

public List<PluginInfo> getChildren(String type)

Filter children by type

Parameters:

type - The type name. must not be null

Returns:

The matching children

isFromSolrConfig

public boolean isFromSolrConfig()

copy

public PluginInfo copy()