model.assignment

Class AssignmentFile

java.lang.Object

java.util.Observable

model.assignment.AssignmentFile

All Implemented Interfaces:

java.util.Observer

public class AssignmentFile
extends java.util.Observable
implements java.util.Observer

AssignmentFile represents the "\config\.txt" files.

Author:

HFW410RA - Philipp Rammos

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,VariableAssignment>	assignments HashMap of all assignments from the AssignmentFile.
private java.util.List<Comment>	comments HashMap of all comments from the AssignmentFile.

Constructor Summary

Constructors

Constructor and Description
AssignmentFile() Default constructor.
AssignmentFile(java.util.Map<java.lang.String,VariableAssignment> assignments2, java.util.List<Comment> comments) Constructor for AssignmentFile, just sets the field.

Method Summary

Modifier and Type	Method and Description
void	addAssignment(VariableAssignment va) Adds an assignment to the assigemnt file.
void	configureAndAdd(UnconfiguredVariableAssignment ass, java.lang.String path, RouterConfiguration rc)
private java.util.Map<Position,VariableAssignment>	createPosAssignmentMap() Creates a Map containing assignment.getPosition() as Key and assignment as Value.
private java.util.Map<Position,Comment>	createPosCommentMap() Creates a Map containing comment.getPosition() as Key and comment as Value.No side effects to fields.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,VariableAssignment>	getAssignments() Returns the field assignments.
java.util.List<Comment>	getComments()
int	hashCode()
private java.lang.StringBuffer	prepareStringToPrint() Prepares the StringBuffer for printing.
java.lang.String	print(java.lang.String pathToPrint) Prints an AssignmentFile containing the VariableAssignments and Comments.
private void	printTheLinesToFile(java.lang.String pathToPrint, java.lang.StringBuffer stringBuffer) The only one method, that real prints lines into the file.
void	removeAssignment(VariableAssignment va) Remove an assignment from the assigemnt file.
private java.util.List<Position>	sortPositions() Sorts the Positions of VariableAssignments and Comments in one List.
void	update(java.util.Observable o, java.lang.Object arg)

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

assignments

private final java.util.Map<java.lang.String,VariableAssignment> assignments

HashMap of all assignments from the AssignmentFile.

comments

private final java.util.List<Comment> comments

HashMap of all comments from the AssignmentFile.

Constructor Detail

AssignmentFile

public AssignmentFile()

Default constructor.

AssignmentFile

public AssignmentFile(java.util.Map<java.lang.String,VariableAssignment> assignments2,
                      java.util.List<Comment> comments)

Constructor for AssignmentFile, just sets the field.

Parameters:

assignments2 - The assignments to set.

comments - The comments to set.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAssignments

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

Returns the field assignments. No side effects.

Returns:

this.assignments;

addAssignment

public void addAssignment(VariableAssignment va)

Adds an assignment to the assigemnt file.

Parameters:

va - the variable assignment to add.

removeAssignment

public void removeAssignment(VariableAssignment va)

Remove an assignment from the assigemnt file.

Parameters:

va - the variable assignment to delete.

getComments

public java.util.List<Comment> getComments()

Returns:

the comments

print

public java.lang.String print(java.lang.String pathToPrint)
                       throws PrinterException

Prints an AssignmentFile containing the VariableAssignments and Comments.

Parameters:

pathToPrint - The path where to print the file.

Returns:

Returns a string representing the printed lines (for testing).

Throws:

PrinterException - If a IOException is thrown.

PrinterException

prepareStringToPrint

private java.lang.StringBuffer prepareStringToPrint()

Prepares the StringBuffer for printing. After this method, the buffer is ready for printing and it will contain the needed lines.

Returns:

The print-ready Buffer.

createPosAssignmentMap

private java.util.Map<Position,VariableAssignment> createPosAssignmentMap()

Creates a Map containing assignment.getPosition() as Key and assignment as Value. No side effects to fields.

Returns:

The created map.

createPosCommentMap

private java.util.Map<Position,Comment> createPosCommentMap()

Creates a Map containing comment.getPosition() as Key and comment as Value.No side effects to fields.

Returns:

The created map.

printTheLinesToFile

private void printTheLinesToFile(java.lang.String pathToPrint,
                                 java.lang.StringBuffer stringBuffer)
                          throws PrinterException

The only one method, that real prints lines into the file.

Parameters:

pathToPrint - The path where to print the file-

stringBuffer - The buffer with the lines to print.

Throws:

PrinterException - If an IOException is caused by the printer.

sortPositions

private java.util.List<Position> sortPositions()

Sorts the Positions of VariableAssignments and Comments in one List.

Returns:

The list of sorted Positions.

configureAndAdd

public void configureAndAdd(UnconfiguredVariableAssignment ass,
                            java.lang.String path,
                            RouterConfiguration rc)
                     throws ParserException

Throws:

ParserException

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Specified by:

update in interface java.util.Observer