net.japanesechess.record
Class ShogiRecord

java.lang.Object
  net.japanesechess.record.ShogiRecord

public class ShogiRecord
extends java.lang.Object

Shogi record class. It is composed of standard attribute value pairs, non standard attribute value pairs, and shogi plies.

Author:

T. Gene Davis

Field Summary

private java.lang.String	date
private java.lang.String	description
private java.lang.String	event
private java.lang.String	gote
private java.lang.String	goteRank
private java.lang.String	handicap
private java.lang.String	joseki
private java.util.ArrayList<ShogiPly>	movesWithComments
private java.util.HashMap<java.lang.String,java.lang.String>	otherNonStandardAttributes
private java.lang.String	result
private java.lang.String	round
private java.lang.String	sente
private java.lang.String	senteRank
private java.lang.String	site

Constructor Summary

ShogiRecord()

Method Summary

void	addNonStandardAttribute(java.lang.String key, java.lang.String value)
void	addShogiPly(ShogiPly sp) Adds ply notation and tries to process the next board byte[].
void	clearNonStandardAttributes()
void	clearRecord()
void	clearShogiPlies()
java.util.ArrayList<ShogiPly>	getAllPlies()
java.lang.String	getDate()
java.lang.String	getDescription()
java.lang.String	getEvent()
java.lang.String	getGote()
java.lang.String	getGoteRank()
java.lang.String	getHandicap()
java.lang.String	getJoseki()
java.util.Set<java.lang.String>	getNonStandardAttributeKeys()
java.lang.String	getNonStandardAttributeValue(java.lang.String key)
ShogiPly	getPly(int p) zero based
int	getPlyCount()
java.lang.String	getResult()
java.lang.String	getRound()
java.lang.String	getSente()
java.lang.String	getSenteRank()
java.lang.String	getSite()
void	removeNonStandardAttribute(java.lang.String key)
void	setDate(java.lang.String date)
void	setDescription(java.lang.String description)
void	setEvent(java.lang.String event)
void	setGote(java.lang.String gote)
void	setGoteRank(java.lang.String goteRank)
void	setHandicap(java.lang.String handicap)
void	setJoseki(java.lang.String joseki)
void	setResult(java.lang.String result)
void	setRound(java.lang.String round)
void	setSente(java.lang.String sente)
void	setSenteRank(java.lang.String senteRank)
void	setSite(java.lang.String site)
java.lang.String	toString() Puts record into valid PSN format and returns as a String.
void	truncate(int newCount) Shortens the record to the new ply count.

Methods inherited from class java.lang.Object

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

Field Detail

date

private java.lang.String date

sente

private java.lang.String sente

gote

private java.lang.String gote

senteRank

private java.lang.String senteRank

goteRank

private java.lang.String goteRank

result

private java.lang.String result

event

private java.lang.String event

round

private java.lang.String round

site

private java.lang.String site

handicap

private java.lang.String handicap

joseki

private java.lang.String joseki

description

private java.lang.String description

otherNonStandardAttributes

private java.util.HashMap<java.lang.String,java.lang.String> otherNonStandardAttributes

movesWithComments

private java.util.ArrayList<ShogiPly> movesWithComments

Constructor Detail

ShogiRecord

public ShogiRecord()

Method Detail

toString

public java.lang.String toString()

Puts record into valid PSN format and returns as a String.

Overrides:

toString in class java.lang.Object

clearRecord

public void clearRecord()

getPlyCount

public int getPlyCount()

getPly

public ShogiPly getPly(int p)

zero based

clearShogiPlies

public void clearShogiPlies()

truncate

public void truncate(int newCount)

Shortens the record to the new ply count. Very useful if the record is going to be used in practice play.

Parameters:

newCount -

getAllPlies

public java.util.ArrayList<ShogiPly> getAllPlies()

addShogiPly

public void addShogiPly(ShogiPly sp)

Adds ply notation and tries to process the next board byte[].

Parameters:

sp -

addNonStandardAttribute

public void addNonStandardAttribute(java.lang.String key,
                                    java.lang.String value)

removeNonStandardAttribute

public void removeNonStandardAttribute(java.lang.String key)

getNonStandardAttributeKeys

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

getNonStandardAttributeValue

public java.lang.String getNonStandardAttributeValue(java.lang.String key)

clearNonStandardAttributes

public void clearNonStandardAttributes()

getDate

public java.lang.String getDate()

Returns:

the date

setDate

public void setDate(java.lang.String date)

Parameters:

date - the date to set

getSente

public java.lang.String getSente()

Returns:

the sente

setSente

public void setSente(java.lang.String sente)

Parameters:

sente - the sente to set

getGote

public java.lang.String getGote()

Returns:

the gote

setGote

public void setGote(java.lang.String gote)

Parameters:

gote - the gote to set

getSenteRank

public java.lang.String getSenteRank()

Returns:

the senteRank

setSenteRank

public void setSenteRank(java.lang.String senteRank)

Parameters:

senteRank - the senteRank to set

getGoteRank

public java.lang.String getGoteRank()

Returns:

the goteRank

setGoteRank

public void setGoteRank(java.lang.String goteRank)

Parameters:

goteRank - the goteRank to set

getResult

public java.lang.String getResult()

Returns:

the result

setResult

public void setResult(java.lang.String result)

Parameters:

result - the result to set

getEvent

public java.lang.String getEvent()

Returns:

the event

setEvent

public void setEvent(java.lang.String event)

Parameters:

event - the event to set

getRound

public java.lang.String getRound()

Returns:

the round

setRound

public void setRound(java.lang.String round)

Parameters:

round - the round to set

getSite

public java.lang.String getSite()

Returns:

the site

setSite

public void setSite(java.lang.String site)

Parameters:

site - the site to set

getHandicap

public java.lang.String getHandicap()

Returns:

the handicap

setHandicap

public void setHandicap(java.lang.String handicap)

Parameters:

handicap - the handicap to set

getJoseki

public java.lang.String getJoseki()

Returns:

the joseki

setJoseki

public void setJoseki(java.lang.String joseki)

Parameters:

joseki - the joseki to set

getDescription

public java.lang.String getDescription()

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set