Package org.wikidata.wdtk.dumpfiles.constraint.template

Class Template

java.lang.Object

org.wikidata.wdtk.dumpfiles.constraint.template.Template

public class Template
extends java.lang.Object

This class represents a particular transclusion of a Wikibase template.

A template is a page created to be included in other pages in the Wikibase system. The transclusion is a method of inclusion where the wikitext of a page contains a reference to the template.

The syntax in the transclusion is of the form:

{{ template_name | parameter₁ | parameter₂ | … | parameter_n }}

Each parameter_i can be of the form: name_i=value_i, or just value_i. The former type of parameter is called named parameter, and the latter is called unnamed parameter. All unnamed parameters are actually implicitly named as sequential positive integers. Thus, the first one is "1", the second one is "2", and so on and so forth.

Author:

Julian Mendez

Constructor Summary

Constructors

Constructor	Description
Template(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> parameters)	Constructs a new template using an identifier, its parameter names with their values.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Returns the identifier of this template.
java.util.Set<java.lang.String>	getParameterNames()	Returns the parameter names that this template has.
java.util.Map<java.lang.String,java.lang.String>	getParameters()	Returns a map containing all parameter names with the associated values that this template has.
java.lang.String	getValue(java.lang.String parameterName)	Returns the value associated to the specified parameter name
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template(java.lang.String name,
                java.util.Map<java.lang.String,java.lang.String> parameters)

Constructs a new template using an identifier, its parameter names with their values. The values need to be already 'resolved'. If they contain references to other templates or Wikibase commands, these values will be considered as simple text.

Parameters:

name - template name

parameters - a map containing the template's parameter names with their values

Method Detail

getName

public java.lang.String getName()

Returns the identifier of this template.

Returns:

the identifier of this template

getParameters

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

Returns a map containing all parameter names with the associated values that this template has.

Returns:

a map containing all parameter names with the associated values that this template has

getParameterNames

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

Returns the parameter names that this template has.

Returns:

the parameter names that this template has

getValue

public java.lang.String getValue(java.lang.String parameterName)

Returns the value associated to the specified parameter name

Parameters:

parameterName - the parameter name

Returns:

the value associated to the specified parameter name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object