metdetection.meter.lpcfg

Class MetricalLpcfgNonterminal

java.lang.Object

metdetection.meter.lpcfg.MetricalLpcfgNonterminal

All Implemented Interfaces:

java.io.Serializable, MetricalLpcfgNode

Direct Known Subclasses:

MetricalLpcfgMeasure

public class MetricalLpcfgNonterminal
extends java.lang.Object
implements MetricalLpcfgNode, java.io.Serializable

A MetricalLpcfgNonterminal is an internal node in a metrical lpcfg tree.

Author:

Andrew McLeod - 25 April, 2016

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricalLpcfgNonterminal.MetricalLpcfgLevel An enum representing the level of a MetricalLpcfgNonterminal
static class	MetricalLpcfgNonterminal.MetricalLpcfgType An enum representing the type of a MetricalLpcfgNonterminal

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MetricalLpcfgNode>	children A List of the children of this node.
private MetricalLpcfgNonterminal.MetricalLpcfgLevel	level The level of this node.
private static long	serialVersionUID Version 1
private MetricalLpcfgNonterminal.MetricalLpcfgType	type The type of this node.

Constructor Summary

Constructors

Constructor and Description
MetricalLpcfgNonterminal(MetricalLpcfgNonterminal.MetricalLpcfgLevel level) Create a new non-terminal, initially of type MetricalLpcfgNonterminal.MetricalLpcfgType.EVEN.
MetricalLpcfgNonterminal(MetricalLpcfgNonterminal nonterminal) Create a new non-terminal as a deep copy of the given one.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(MetricalLpcfgNode child) Add a new node as a child of this non-terminal.
MetricalLpcfgNonterminal	deepCopy() Get a deep copy of this node.
boolean	equals(java.lang.Object o)
void	fixChildrenTypes() Fix the types of all of the children of this non-terminal.
java.util.List<MetricalLpcfgNode>	getChildren() Get the children of this non-terminal.
MetricalLpcfgHead	getHead() Get the head of this non-terminal.
int	getLength() Get the length of this node, measured in sub beats.
MetricalLpcfgNonterminal.MetricalLpcfgLevel	getLevel() Get the level of this non-terminal.
MetricalLpcfgTerminal	getTerminal() Get the terminal at this level of the tree.
java.lang.String	getTransitionString() Get the transition String of this non-terminal.
java.lang.String	getTypeString() Get the String of the type of this node.
boolean	isEmpty() Get if this node is empty or not.
void	setType(MetricalLpcfgNonterminal.MetricalLpcfgType type) Set the type to the given value.
boolean	startsWithRest() Get if this node starts with a REST or not.
java.lang.String	toString()
java.lang.String	toStringPretty(int depth, java.lang.String tab) Print the given node recursively in a pretty format.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Version 1

See Also:

Constant Field Values

type

private MetricalLpcfgNonterminal.MetricalLpcfgType type

The type of this node.

level

private final MetricalLpcfgNonterminal.MetricalLpcfgLevel level

The level of this node.

children

private final java.util.List<MetricalLpcfgNode> children

A List of the children of this node.

Constructor Detail

MetricalLpcfgNonterminal

public MetricalLpcfgNonterminal(MetricalLpcfgNonterminal.MetricalLpcfgLevel level)

Create a new non-terminal, initially of type MetricalLpcfgNonterminal.MetricalLpcfgType.EVEN.

Parameters:

level - level

MetricalLpcfgNonterminal

public MetricalLpcfgNonterminal(MetricalLpcfgNonterminal nonterminal)

Create a new non-terminal as a deep copy of the given one.

Parameters:

nonterminal - The non-terminal we want a deep copy of.

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: MetricalLpcfgNode

Get if this node is empty or not.

Specified by:

isEmpty in interface MetricalLpcfgNode

Returns:

True if this node contains no notes. False otherwise.

startsWithRest

public boolean startsWithRest()

Description copied from interface: MetricalLpcfgNode

Get if this node starts with a REST or not.

Specified by:

startsWithRest in interface MetricalLpcfgNode

Returns:

True if this node starts with a REST. False otherwise.

getChildren

public java.util.List<MetricalLpcfgNode> getChildren()

Get the children of this non-terminal.

Returns:

children

addChild

public void addChild(MetricalLpcfgNode child)

Add a new node as a child of this non-terminal. The node will be added at the end of the current child list.

Parameters:

child - The new child node to add to children

setType

public void setType(MetricalLpcfgNonterminal.MetricalLpcfgType type)

Set the type to the given value.

Parameters:

type - type

getTypeString

public java.lang.String getTypeString()

Get the String of the type of this node.

Returns:

type's toString.

getLevel

public MetricalLpcfgNonterminal.MetricalLpcfgLevel getLevel()

Get the level of this non-terminal.

Returns:

level

getTerminal

public MetricalLpcfgTerminal getTerminal()

Description copied from interface: MetricalLpcfgNode

Get the terminal at this level of the tree.

Specified by:

getTerminal in interface MetricalLpcfgNode

Returns:

The terminal at this node.

getTransitionString

public java.lang.String getTransitionString()

Get the transition String of this non-terminal.

Returns:

The transition String of this non-terminal.

getHead

public MetricalLpcfgHead getHead()

Get the head of this non-terminal. This is calculated recursively as the max of the heads of all of its children with onsets shifted, or a length 0 head if it has no children.

Specified by:

getHead in interface MetricalLpcfgNode

Returns:

The head of this non-terminal.

fixChildrenTypes

public void fixChildrenTypes()

Fix the types of all of the children of this non-terminal. If a child is a terminal node, do nothing to it.

getLength

public int getLength()

Description copied from interface: MetricalLpcfgNode

Get the length of this node, measured in sub beats.

Specified by:

getLength in interface MetricalLpcfgNode

Returns:

The length of this node in sub beats.

deepCopy

public MetricalLpcfgNonterminal deepCopy()

Description copied from interface: MetricalLpcfgNode

Get a deep copy of this node. Each node needs this because we sometimes need a deep copy of the entire tree.

Specified by:

deepCopy in interface MetricalLpcfgNode

Returns:

A deep copy of this node.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toStringPretty

public java.lang.String toStringPretty(int depth,
                              java.lang.String tab)

Description copied from interface: MetricalLpcfgNode

Print the given node recursively in a pretty format.

Specified by:

toStringPretty in interface MetricalLpcfgNode

Parameters:

depth - The depth of this node.

tab - The tab String to indent tree levels.

Returns:

This node in a pretty recursive format.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object