Package org.harctoolbox.irp

Class IrpDatabase

java.lang.Object

org.harctoolbox.irp.IrpDatabase

All Implemented Interfaces:

Serializable, Iterable<NamedProtocol>

public final class IrpDatabase
extends Object
implements Iterable<NamedProtocol>, Serializable

This class is a data bases manager for the data base of IRP protocols. It reads a configuration file containing definitions for IR format in the IRP-Notation.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABSOLUTE_TOLERANCE_NAME
static final String	ALT_NAME_NAME
static final String	DECODABLE_NAME
static final String	DECODE_ONLY_NAME
static final String	DEFAULT_CONFIG_FILE
static final String	DOCUMENTATION_ELEMENT_NAME
static final String	DOCUMENTATION_NAME
static final String	FALSE_NAME
static final String	FREQUENCY_LOWER_NAME
static final String	FREQUENCY_TOLERANCE_NAME
static final String	FREQUENCY_UPPER_NAME
static final String	HTML_NAME
static final String	IRP_ELEMENT_NAME
static final String	IRP_NAME
static final String	IRP_NAMESPACE_PREFIX
static final String	IRP_PROTOCOL_NS
static final String	IRP_PROTOCOL_SCHEMA_LOCATION
static final String	IRP_SCHEMA_FILE
static final String	META_DATA_NAME
static final String	MINIMUM_LEADOUT_NAME
static final String	NAME_NAME
static final String	NAMED_PROTOCOLS_NAME
static final String	NO_NAME
static final String	PARAMETER_ELEMENT_NAME
static final String	PARAMETER_NAME
static final String	PARAMETERS_NAME
static final String	PREFER_OVER_NAME
static final String	PROG_VERSION_NAME
static final String	PROTOCOL_CNAME_NAME
static final String	PROTOCOL_NAME
static final String	PROTOCOL_NAME_NAME
static final String	PROTOCOLS_NAME
static final String	REJECT_REPEATLESS_NAME
static final String	RELATIVE_TOLERANCE_NAME
static final String	TYPE_NAME
static final String	UNNAMED
static final String	USABLE_NAME
static final String	VALUE_NAME
static final String	VERSION_NAME
static final String	XML_NAME
static final String	YES_NAME

Constructor Summary

Constructors

Constructor	Description
IrpDatabase()	Returns an empty IrpDatabase.
IrpDatabase(File file)
IrpDatabase(InputStream inputStream)
IrpDatabase(Reader reader)
IrpDatabase(Iterable<File> files)
IrpDatabase(String file)
IrpDatabase(Document doc)
IrpDatabase(Element protocolsElement)

Method Summary

Modifier and Type	Method	Description
void	addProperty(String protocolName, String key, String value)
void	addProtocol(String protocolName, String irp)
void	addProtocol(String protocolName, String irp, DocumentFragment doc)
String	checkSorted()	Checks if the data base is sorted with respect to the protocol name's.
List<String>	evaluateProtocols(List<String> protocols, boolean sort, boolean regexp, boolean urlDecode)
String	expandAlias(String protocol)
Set<String>	getAliases()
String	getConfigFileVersion()
String	getDocumentation(String protocolName)
String	getDocumentationExpandAlias(String protocolName)
String	getFirstProperty(String protocolName, String key)
DocumentFragment	getHtmlDocumentation(String protocolName)
String	getIrp(String name)
static String	getIrp(String configFilename, String protocolName)	Static version of getIrp.
String	getIrpExpandAlias(String name)
Set<String>	getKeys()	Returns the keys of the protocol data base, which happens to be the protocol names converted to lower case.
List<String>	getMatchingNames(Iterable<String> iterable, boolean regexp, boolean urlDecode)
List<String>	getMatchingNamesExact(String string)
List<String>	getMatchingNamesRegexp(String regexp)
String	getName(String name)
NamedProtocol	getNamedProtocol(String protocolName)
List<NamedProtocol>	getNamedProtocol(Collection<String> protocolNames)
NamedProtocol	getNamedProtocolExpandAlias(String protocolName)
String	getNameExpandAlias(String name)
List<String>	getNames()
Protocol	getNonRecycledProtocol(String protocolName)	Returns a Protocol with the prescribed name.
String	getNormalFormIrp(String protocolName, int radix)
List<String>	getProperties(String protocolName, String key)
Protocol	getProtocol(String protocolName)	Returns a Protocol with the prescribed name.
Protocol	getProtocolExpandAlias(String protocolName)
static Schema	getSchema()
String	getVersion()
List<DocumentFragment>	getXmlProperties(String protocolName, String key)
boolean	isAlias(String protocol)
boolean	isEmpty()
boolean	isKnown(String protocol)
static boolean	isKnown(String protocolsPath, String protocol)
boolean	isKnownExpandAlias(String protocol)
static boolean	isValidating()
Iterator<NamedProtocol>	iterator()	This is a comparatively expensive operation, while its next() performs actual parsing of the IRP string.
static IrpDatabase	newDefaultIrpDatabase()
static IrpDatabase	parseIrp(String protocolName, String irp, String documentation)
static IrpDatabase	parseIrp(String protocolName, String irp, DocumentFragment documentation)
static IrpDatabase	parseIrp(Map<String,String> map)
void	patch(File file)
void	patch(Reader reader)
void	patch(String file)
void	patch(IrpDatabase irpDatabase)
void	patch(Document document)
void	remove(Iterable<String> blackList)
void	remove(String protocolName)
void	removeProperties(String protocolName, String key)
void	removeXmlProperties(String protocolName, String key)
IrSignal	render(String protocolName, Map<String,Long> params)
void	setDocumentation(String protocolName, String string)
void	setDocumentation(String protocolName, DocumentFragment fragment)
void	setProperties(String protocolName, String key, List<String> properties)
static void	setValidating(boolean newValidating)
void	setXmlProperties(String protocolName, String key, List<DocumentFragment> properties)
int	size()
Document	toDocument()
Document	toDocument(Iterable<String> protocolsNames)
Document	toDocument(Iterable<String> protocolsNames, boolean includeComments)
Document	toDocument(Iterable<String> protocolNames, Double absoluteTolerance, Double relativeTolerance, Double frequencyTolerance, Double minimumLeadout)
Element	toElement(Document doc)
Element	toElement(Document doc, Iterable<String> protocolNames)
Element	toElement(Document document, Iterable<String> protocolNames, Double absoluteTolerance, Double relativeTolerance, Double frequencyTolerance, Double minimumLeadout)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

DEFAULT_CONFIG_FILE

public static final String DEFAULT_CONFIG_FILE

See Also:

• Constant Field Values

IRP_PROTOCOL_NS

public static final String IRP_PROTOCOL_NS

See Also:

• Constant Field Values

IRP_SCHEMA_FILE

public static final String IRP_SCHEMA_FILE

See Also:

• Constant Field Values

IRP_PROTOCOL_SCHEMA_LOCATION

public static final String IRP_PROTOCOL_SCHEMA_LOCATION

See Also:

• Constant Field Values

IRP_NAMESPACE_PREFIX

public static final String IRP_NAMESPACE_PREFIX

See Also:

• Constant Field Values

UNNAMED

public static final String UNNAMED

See Also:

• Constant Field Values

PROTOCOL_NAME

public static final String PROTOCOL_NAME

See Also:

• Constant Field Values

PROTOCOLS_NAME

public static final String PROTOCOLS_NAME

See Also:

• Constant Field Values

NAME_NAME

public static final String NAME_NAME

See Also:

• Constant Field Values

IRP_NAME

public static final String IRP_NAME

See Also:

• Constant Field Values

IRP_ELEMENT_NAME

public static final String IRP_ELEMENT_NAME

See Also:

• Constant Field Values

USABLE_NAME

public static final String USABLE_NAME

See Also:

• Constant Field Values

VERSION_NAME

public static final String VERSION_NAME

See Also:

• Constant Field Values

PROG_VERSION_NAME

public static final String PROG_VERSION_NAME

See Also:

• Constant Field Values

DOCUMENTATION_NAME

public static final String DOCUMENTATION_NAME

See Also:

• Constant Field Values

DOCUMENTATION_ELEMENT_NAME

public static final String DOCUMENTATION_ELEMENT_NAME

See Also:

• Constant Field Values

PARAMETER_NAME

public static final String PARAMETER_NAME

See Also:

• Constant Field Values

DECODABLE_NAME

public static final String DECODABLE_NAME

See Also:

• Constant Field Values

FREQUENCY_TOLERANCE_NAME

public static final String FREQUENCY_TOLERANCE_NAME

See Also:

• Constant Field Values

FREQUENCY_LOWER_NAME

public static final String FREQUENCY_LOWER_NAME

See Also:

• Constant Field Values

FREQUENCY_UPPER_NAME

public static final String FREQUENCY_UPPER_NAME

See Also:

• Constant Field Values

RELATIVE_TOLERANCE_NAME

public static final String RELATIVE_TOLERANCE_NAME

See Also:

• Constant Field Values

ABSOLUTE_TOLERANCE_NAME

public static final String ABSOLUTE_TOLERANCE_NAME

See Also:

• Constant Field Values

MINIMUM_LEADOUT_NAME

public static final String MINIMUM_LEADOUT_NAME

See Also:

• Constant Field Values

PREFER_OVER_NAME

public static final String PREFER_OVER_NAME

See Also:

• Constant Field Values

ALT_NAME_NAME

public static final String ALT_NAME_NAME

See Also:

• Constant Field Values

REJECT_REPEATLESS_NAME

public static final String REJECT_REPEATLESS_NAME

See Also:

• Constant Field Values

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

XML_NAME

public static final String XML_NAME

See Also:

• Constant Field Values

FALSE_NAME

public static final String FALSE_NAME

See Also:

• Constant Field Values

HTML_NAME

public static final String HTML_NAME

See Also:

• Constant Field Values

VALUE_NAME

public static final String VALUE_NAME

See Also:

• Constant Field Values

PARAMETERS_NAME

public static final String PARAMETERS_NAME

See Also:

• Constant Field Values

PARAMETER_ELEMENT_NAME

public static final String PARAMETER_ELEMENT_NAME

See Also:

• Constant Field Values

NAMED_PROTOCOLS_NAME

public static final String NAMED_PROTOCOLS_NAME

See Also:

• Constant Field Values

DECODE_ONLY_NAME

public static final String DECODE_ONLY_NAME

See Also:

• Constant Field Values

PROTOCOL_NAME_NAME

public static final String PROTOCOL_NAME_NAME

See Also:

• Constant Field Values

PROTOCOL_CNAME_NAME

public static final String PROTOCOL_CNAME_NAME

See Also:

• Constant Field Values

META_DATA_NAME

public static final String META_DATA_NAME

See Also:

• Constant Field Values

YES_NAME

public static final String YES_NAME

See Also:

• Constant Field Values

NO_NAME

public static final String NO_NAME

See Also:

• Constant Field Values

Constructor Details

IrpDatabase

public IrpDatabase(Reader reader)
            throws IOException,
IrpParseException,
SAXException

Throws:

IOException

IrpParseException

SAXException

IrpDatabase

public IrpDatabase(InputStream inputStream)
            throws IOException,
IrpParseException,
SAXException

Throws:

IOException

IrpParseException

SAXException

IrpDatabase

public IrpDatabase(File file)
            throws IOException,
IrpParseException,
SAXException

Throws:

IOException

IrpParseException

SAXException

IrpDatabase

public IrpDatabase(String file)
            throws IOException,
IrpParseException,
SAXException

Throws:

IOException

IrpParseException

SAXException

IrpDatabase

public IrpDatabase(Iterable<File> files)
            throws IrpParseException,
IOException,
SAXException

Throws:

IrpParseException

IOException

SAXException

IrpDatabase

public IrpDatabase()

Returns an empty IrpDatabase.

IrpDatabase

public IrpDatabase(Document doc)
            throws IrpParseException

Throws:

IrpParseException

IrpDatabase

public IrpDatabase(Element protocolsElement)
            throws IrpParseException

Throws:

IrpParseException

Method Details

isValidating

public static boolean isValidating()

setValidating

public static void setValidating(boolean newValidating)
                          throws SAXException

Throws:

SAXException

getSchema

public static Schema getSchema()

isKnown

public static boolean isKnown(String protocolsPath,
 String protocol)
                       throws IOException,
IrpParseException,
SAXException

Throws:

IOException

IrpParseException

SAXException

getIrp

public static String getIrp(String configFilename,
 String protocolName)
                     throws IrpParseException,
UnknownProtocolException,
IOException,
SAXException

Static version of getIrp.

Parameters:

configFilename -

protocolName -

Returns:

String with IRP representation

Throws:

IrpParseException

UnknownProtocolException

IOException

SAXException

parseIrp

public static IrpDatabase parseIrp(String protocolName,
 String irp,
 String documentation)
                            throws IrpParseException

Throws:

IrpParseException

parseIrp

public static IrpDatabase parseIrp(String protocolName,
 String irp,
 DocumentFragment documentation)
                            throws IrpParseException

Throws:

IrpParseException

parseIrp

public static IrpDatabase parseIrp(Map<String,String> map)
                            throws IrpParseException

Throws:

IrpParseException

newDefaultIrpDatabase

public static IrpDatabase newDefaultIrpDatabase()

patch

public void patch(IrpDatabase irpDatabase)

patch

public void patch(Reader reader)
           throws IOException,
SAXException,
IrpParseException

Throws:

IOException

SAXException

IrpParseException

patch

public void patch(File file)
           throws IOException,
SAXException,
IrpParseException

Throws:

IOException

SAXException

IrpParseException

patch

public void patch(String file)
           throws IOException,
SAXException,
IrpParseException

Throws:

IOException

SAXException

IrpParseException

patch

public void patch(Document document)
           throws IrpParseException

Throws:

IrpParseException

addProtocol

public void addProtocol(String protocolName,
 String irp)
                 throws IrpParseException

Throws:

IrpParseException

addProtocol

public void addProtocol(String protocolName,
 String irp,
 DocumentFragment doc)
                 throws IrpParseException

Throws:

IrpParseException

toDocument

public Document toDocument()

toDocument

public Document toDocument(Iterable<String> protocolsNames)

toDocument

public Document toDocument(Iterable<String> protocolsNames,
 boolean includeComments)

toDocument

public Document toDocument(Iterable<String> protocolNames,
 Double absoluteTolerance,
 Double relativeTolerance,
 Double frequencyTolerance,
 Double minimumLeadout)

toElement

public Element toElement(Document doc)

toElement

public Element toElement(Document doc,
 Iterable<String> protocolNames)

toElement

public Element toElement(Document document,
 Iterable<String> protocolNames,
 Double absoluteTolerance,
 Double relativeTolerance,
 Double frequencyTolerance,
 Double minimumLeadout)

getConfigFileVersion

public String getConfigFileVersion()

Returns:

the configFileVersion

isAlias

public boolean isAlias(String protocol)

expandAlias

public String expandAlias(String protocol)

isKnown

public boolean isKnown(String protocol)

isKnownExpandAlias

public boolean isKnownExpandAlias(String protocol)

getIrp

public String getIrp(String name)
              throws UnknownProtocolException

Throws:

UnknownProtocolException

getIrpExpandAlias

public String getIrpExpandAlias(String name)
                         throws UnknownProtocolException

Throws:

UnknownProtocolException

getKeys

public Set<String> getKeys()

Returns the keys of the protocol data base, which happens to be the protocol names converted to lower case.

Returns:

getNames

public List<String> getNames()

getAliases

public Set<String> getAliases()

getName

public String getName(String name)
               throws UnknownProtocolException

Throws:

UnknownProtocolException

getNameExpandAlias

public String getNameExpandAlias(String name)
                          throws UnknownProtocolException

Throws:

UnknownProtocolException

size

public int size()

isEmpty

public boolean isEmpty()

getMatchingNamesRegexp

public List<String> getMatchingNamesRegexp(String regexp)

getMatchingNamesExact

public List<String> getMatchingNamesExact(String string)

getMatchingNames

public List<String> getMatchingNames(Iterable<String> iterable,
 boolean regexp,
 boolean urlDecode)

getDocumentation

public String getDocumentation(String protocolName)
                        throws UnknownProtocolException

Throws:

UnknownProtocolException

getHtmlDocumentation

public DocumentFragment getHtmlDocumentation(String protocolName)
                                      throws UnknownProtocolException

Throws:

UnknownProtocolException

setDocumentation

public void setDocumentation(String protocolName,
 String string)
                      throws UnknownProtocolException

Throws:

UnknownProtocolException

setDocumentation

public void setDocumentation(String protocolName,
 DocumentFragment fragment)
                      throws UnknownProtocolException

Throws:

UnknownProtocolException

getDocumentationExpandAlias

public String getDocumentationExpandAlias(String protocolName)
                                   throws UnknownProtocolException

Throws:

UnknownProtocolException

getFirstProperty

public String getFirstProperty(String protocolName,
 String key)
                        throws UnknownProtocolException

Throws:

UnknownProtocolException

getProperties

public List<String> getProperties(String protocolName,
 String key)
                           throws UnknownProtocolException

Throws:

UnknownProtocolException

addProperty

public void addProperty(String protocolName,
 String key,
 String value)
                 throws UnknownProtocolException

Throws:

UnknownProtocolException

setProperties

public void setProperties(String protocolName,
 String key,
 List<String> properties)
                   throws UnknownProtocolException

Throws:

UnknownProtocolException

removeProperties

public void removeProperties(String protocolName,
 String key)
                      throws UnknownProtocolException

Throws:

UnknownProtocolException

getXmlProperties

public List<DocumentFragment> getXmlProperties(String protocolName,
 String key)
                                        throws UnknownProtocolException

Throws:

UnknownProtocolException

setXmlProperties

public void setXmlProperties(String protocolName,
 String key,
 List<DocumentFragment> properties)
                      throws UnknownProtocolException

Throws:

UnknownProtocolException

removeXmlProperties

public void removeXmlProperties(String protocolName,
 String key)
                         throws UnknownProtocolException

Throws:

UnknownProtocolException

getNamedProtocol

public NamedProtocol getNamedProtocol(String protocolName)
                               throws UnknownProtocolException,
InvalidNameException,
UnsupportedRepeatException,
IrpInvalidArgumentException,
NameUnassignedException

Throws:

UnknownProtocolException

InvalidNameException

UnsupportedRepeatException

IrpInvalidArgumentException

NameUnassignedException

getNamedProtocolExpandAlias

public NamedProtocol getNamedProtocolExpandAlias(String protocolName)
                                          throws UnknownProtocolException,
InvalidNameException,
UnsupportedRepeatException,
IrpInvalidArgumentException,
NameUnassignedException

Throws:

UnknownProtocolException

InvalidNameException

UnsupportedRepeatException

IrpInvalidArgumentException

NameUnassignedException

getNamedProtocol

public List<NamedProtocol> getNamedProtocol(Collection<String> protocolNames)

remove

public void remove(Iterable<String> blackList)
            throws UnknownProtocolException

Throws:

UnknownProtocolException

remove

public void remove(String protocolName)
            throws UnknownProtocolException

Throws:

UnknownProtocolException

evaluateProtocols

public List<String> evaluateProtocols(List<String> protocols,
 boolean sort,
 boolean regexp,
 boolean urlDecode)

getNonRecycledProtocol

public Protocol getNonRecycledProtocol(String protocolName)
                                throws UnknownProtocolException,
UnsupportedRepeatException,
NameUnassignedException,
InvalidNameException,
IrpInvalidArgumentException

Returns a Protocol with the prescribed name. As opposed to getProtocol(String), the Protocol is guaranteed to be newly constructed, and it will not be recycled.

Parameters:

protocolName -

Returns:

Protocol, guaranteed new.

Throws:

UnknownProtocolException

UnsupportedRepeatException

NameUnassignedException

InvalidNameException

IrpInvalidArgumentException

getProtocol

public Protocol getProtocol(String protocolName)
                     throws UnknownProtocolException,
UnsupportedRepeatException,
NameUnassignedException,
InvalidNameException,
IrpInvalidArgumentException

Returns a Protocol with the prescribed name. If this has been called previously with the same argument, the previously constructed Protocol is recycled and returned. See also getNonRecycledProtocol(String).

Parameters:

protocolName -

Returns:

Protocol, possibly recycled.

Throws:

UnknownProtocolException

UnsupportedRepeatException

NameUnassignedException

InvalidNameException

IrpInvalidArgumentException

getProtocolExpandAlias

public Protocol getProtocolExpandAlias(String protocolName)
                                throws UnknownProtocolException,
UnsupportedRepeatException,
NameUnassignedException,
InvalidNameException,
IrpInvalidArgumentException

Throws:

UnknownProtocolException

UnsupportedRepeatException

NameUnassignedException

InvalidNameException

IrpInvalidArgumentException

getNormalFormIrp

public String getNormalFormIrp(String protocolName,
 int radix)
                        throws UnknownProtocolException,
InvalidNameException,
UnsupportedRepeatException,
NameUnassignedException,
IrpInvalidArgumentException

Throws:

UnknownProtocolException

InvalidNameException

UnsupportedRepeatException

NameUnassignedException

IrpInvalidArgumentException

checkSorted

public String checkSorted()

Checks if the data base is sorted with respect to the protocol name's.

Returns:

First offending protocol, or null if the database is sorted.

render

public IrSignal render(String protocolName,
 Map<String,Long> params)
                throws IrpException

Throws:

IrpException

iterator

public Iterator<NamedProtocol> iterator()

This is a comparatively expensive operation, while its next() performs actual parsing of the IRP string.

Specified by:

iterator in interface Iterable<NamedProtocol>

Returns:

getVersion

public String getVersion()