org.dice_research.topicmodeling.commons.sort

Class AssociativeSortClassGenerator

java.lang.Object

org.dice_research.topicmodeling.commons.sort.AssociativeSortClassGenerator

class AssociativeSortClassGenerator
extends Object

This class is used to generate the classes AssociativeSort and AssociativeSortTest containing the JUnit tests for the AssociativeSort class. It should only be run if these classes should be changed.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field and Description
private static String	ARRAY_EQUALS_DELTA_ASSOCIATED_ARRAY_KEY Defining the String which will be replaced with the delta which is needed to compare double or float values of the associated array in the JUnit tests (or an empty String if the type of the associated array is not double or float).
private static String	ARRAY_EQUALS_DELTA_SORTED_ARRAY_KEY Defining the String which will be replaced with the delta which is needed to compare double or float values of the sorted array in the JUnit tests (or an empty String if the type of the sorted array is not double or float).
private static String	ASSOCIATED_TYPE_EXAMPLE_KEY Defining the String which will be replaced with the example array for the associated array.
private static String	ASSOCIATED_TYPE_KEY Defining the String which will be replaced with the type of the associated array.
private static String[]	associatedTypes Defining the types the associated array can have.
private static String	CLASS_FEAT String defining the feet of the AssociativeSort class.
private static String	CLASS_HEAD Head of the AssociativeSort class.
private static HashMap<String,String>	exampleArrays Defining the sorted example arrays used for the JUnit tests.
private static String	GENERIC_DECLARATION_KEY Defining the String which will be replaced with the generic type declaration (or with an empty String if the generic type declaration is not needed).
private static String	INSERTION_SORT_METHOD1 String defining the insertion sort.
private static String	INSERTION_SORT_METHOD2 String defining the insertion sort.
private static String	PARTITION_METHOD String defining the partitioning method
private static String	PATH_TO_ASSOCIATIVE_SORT_CLASS_FILE The path to the .java file of the AssociativeSort class.
private static String	PATH_TO_ASSOCIATIVE_SORT_TEST_CLASS_FILE The path to the .java file of the JUnit test class AssociativeSortTest.
private static String[]	primitiveSortTypes Defining the types the sorted array can have.
private static String	QUICK_SORT_METHOD1 String defining the quick sort method
private static String	QUICK_SORT_METHOD2 String defining the quick sort method
private static String	SORTED_TYPE_EXAMPLE_KEY Defining the String which will be replaced with the example array for the sorted array.
private static String	SORTED_TYPE_KEY Defining the String which will be replaced with the type of the sorted array.
private static String	SWAP_METHOD String defining the swap method
private static String	TEST_CLASS_FEAT String defining the feet of the AssociativeSortTest class.
private static String	TEST_CLASS_HEAD Head of the AssociativeSortTest class.
private static String	TEST_METHOD String defining the JUnit test method.
private static String	TEST_METHOD_NAME_KEY Defining the String which will be replaced with the name of the test method.
private FileWriter	writer FileWriter used for creating the files.

Constructor Summary

Constructors

Constructor and Description
AssociativeSortClassGenerator()

Method Summary

Modifier and Type	Method and Description
private String	getArrayDelta(String type) Returns a String defining a delta for the equal assertion of the JUnit tests if the given type is double or float.
static void	main(String[] args) Starts the generation.
private void	prepareFile(File file)
private void	writeAssociativeSortClasses(String[] primitiveSortTypes, String[] associatedTypes, HashMap<String,String> exampleArrays) This method writes the two classes.
private void	writeMethod(String method, String sortedType, String associatedType, String genericDeclaration) Method which writes the given method replacing the SORTED_TYPE_KEY, the ASSOCIATED_TYPE_KEY, and the GENERIC_DECLARATION_KEY using the given values.
private void	writeMethods(String[] primitiveSortTypes, String[] associatedTypes) This method writes the methods of the AssociativeSort class for the combinations of the given types.
private void	writeMethods(String sortedType, String associatedType) Writes the methods for a given type pair.
private void	writeMethods(String sortedType, String associatedType, String genericDeclaration) Writes the methods for a given type pair using the given generic declaration.
private void	writeTestMethod(String sortedType, String sortedTypeExample, String associatedType, String associatedTypeExample) writes the test method for a single combination of a sorted array type and an associated array type.
private void	writeTestMethods(String[] primitiveSortTypes, String[] associatedTypes, HashMap<String,String> exampleArrays) This method writes the test methods for the combinations of the given example arrays and the types of the sorted and the associated array.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_TO_ASSOCIATIVE_SORT_CLASS_FILE

private static final String PATH_TO_ASSOCIATIVE_SORT_CLASS_FILE

The path to the .java file of the AssociativeSort class.

See Also:

Constant Field Values

PATH_TO_ASSOCIATIVE_SORT_TEST_CLASS_FILE

private static final String PATH_TO_ASSOCIATIVE_SORT_TEST_CLASS_FILE

The path to the .java file of the JUnit test class AssociativeSortTest.

See Also:

Constant Field Values

SORTED_TYPE_KEY

private static final String SORTED_TYPE_KEY

Defining the String which will be replaced with the type of the sorted array.

See Also:

Constant Field Values

ASSOCIATED_TYPE_KEY

private static final String ASSOCIATED_TYPE_KEY

Defining the String which will be replaced with the type of the associated array.

See Also:

Constant Field Values

GENERIC_DECLARATION_KEY

private static final String GENERIC_DECLARATION_KEY

Defining the String which will be replaced with the generic type declaration (or with an empty String if the generic type declaration is not needed).

See Also:

Constant Field Values

TEST_METHOD_NAME_KEY

private static final String TEST_METHOD_NAME_KEY

Defining the String which will be replaced with the name of the test method.

See Also:

Constant Field Values

ARRAY_EQUALS_DELTA_SORTED_ARRAY_KEY

private static final String ARRAY_EQUALS_DELTA_SORTED_ARRAY_KEY

Defining the String which will be replaced with the delta which is needed to compare double or float values of the sorted array in the JUnit tests (or an empty String if the type of the sorted array is not double or float).

See Also:

Constant Field Values

ARRAY_EQUALS_DELTA_ASSOCIATED_ARRAY_KEY

private static final String ARRAY_EQUALS_DELTA_ASSOCIATED_ARRAY_KEY

Defining the String which will be replaced with the delta which is needed to compare double or float values of the associated array in the JUnit tests (or an empty String if the type of the associated array is not double or float).

See Also:

Constant Field Values

SORTED_TYPE_EXAMPLE_KEY

private static final String SORTED_TYPE_EXAMPLE_KEY

Defining the String which will be replaced with the example array for the sorted array.

See Also:

Constant Field Values

ASSOCIATED_TYPE_EXAMPLE_KEY

private static final String ASSOCIATED_TYPE_EXAMPLE_KEY

Defining the String which will be replaced with the example array for the associated array.

See Also:

Constant Field Values

primitiveSortTypes

private static final String[] primitiveSortTypes

Defining the types the sorted array can have.

associatedTypes

private static final String[] associatedTypes

Defining the types the associated array can have.

exampleArrays

private static final HashMap<String,String> exampleArrays

Defining the sorted example arrays used for the JUnit tests.

writer

private FileWriter writer

FileWriter used for creating the files.

CLASS_HEAD

private static final String CLASS_HEAD

Head of the AssociativeSort class.

See Also:

Constant Field Values

SWAP_METHOD

private static final String SWAP_METHOD

String defining the swap method

See Also:

Constant Field Values

QUICK_SORT_METHOD1

private static final String QUICK_SORT_METHOD1

String defining the quick sort method

See Also:

Constant Field Values

QUICK_SORT_METHOD2

private static final String QUICK_SORT_METHOD2

String defining the quick sort method

See Also:

Constant Field Values

PARTITION_METHOD

private static final String PARTITION_METHOD

String defining the partitioning method

See Also:

Constant Field Values

INSERTION_SORT_METHOD1

private static final String INSERTION_SORT_METHOD1

String defining the insertion sort.

See Also:

Constant Field Values

INSERTION_SORT_METHOD2

private static final String INSERTION_SORT_METHOD2

String defining the insertion sort.

See Also:

Constant Field Values

CLASS_FEAT

private static final String CLASS_FEAT

String defining the feet of the AssociativeSort class.

See Also:

Constant Field Values

TEST_CLASS_HEAD

private static final String TEST_CLASS_HEAD

Head of the AssociativeSortTest class.

See Also:

Constant Field Values

TEST_METHOD

private static final String TEST_METHOD

String defining the JUnit test method.

See Also:

Constant Field Values

TEST_CLASS_FEAT

private static final String TEST_CLASS_FEAT

String defining the feet of the AssociativeSortTest class.

See Also:

Constant Field Values

Constructor Detail

AssociativeSortClassGenerator

AssociativeSortClassGenerator()

Method Detail

main

public static void main(String[] args)

Starts the generation.

Parameters:

args -

writeAssociativeSortClasses

private void writeAssociativeSortClasses(String[] primitiveSortTypes,
                                         String[] associatedTypes,
                                         HashMap<String,String> exampleArrays)
                                  throws IOException

This method writes the two classes.

Parameters:

primitiveSortTypes - array containing the types for the sorted array

associatedTypes - array containing the types for the associated array

exampleArrays - Map containing the types and their example arrays

Throws:

IOException - thrown by the used writer

prepareFile

private void prepareFile(File file)

writeMethods

private void writeMethods(String[] primitiveSortTypes,
                          String[] associatedTypes)
                   throws IOException

This method writes the methods of the AssociativeSort class for the combinations of the given types. Additionally for every sorted type methods for a generic associated type are generated.

Parameters:

primitiveSortTypes - types the sorted arrays can have

associatedTypes - types the associated arrays can have

Throws:

IOException

writeMethods

private void writeMethods(String sortedType,
                          String associatedType)
                   throws IOException

Writes the methods for a given type pair.

Parameters:

sortedType - type the sorted array can have

associatedType - types the associated array can have

Throws:

IOException

writeMethods

private void writeMethods(String sortedType,
                          String associatedType,
                          String genericDeclaration)
                   throws IOException

Writes the methods for a given type pair using the given generic declaration.

Parameters:

sortedType - type the sorted array can have

associatedType - types the associated array can have

genericDeclaration - String declaring a generic or an empty String

Throws:

IOException

writeMethod

private void writeMethod(String method,
                         String sortedType,
                         String associatedType,
                         String genericDeclaration)
                  throws IOException

Method which writes the given method replacing the SORTED_TYPE_KEY, the ASSOCIATED_TYPE_KEY, and the GENERIC_DECLARATION_KEY using the given values.

Parameters:

method - method which should be written

sortedType - type of the sorted array which should be inserted into the method

associatedType - type of the associated array which should be inserted into the method

genericDeclaration - generic type declaration which should be inserted into the method

Throws:

IOException

writeTestMethods

private void writeTestMethods(String[] primitiveSortTypes,
                              String[] associatedTypes,
                              HashMap<String,String> exampleArrays)
                       throws IOException

This method writes the test methods for the combinations of the given example arrays and the types of the sorted and the associated array. Note that a test method is written only if there are examples for the sorted and for the associated array type.

Parameters:

primitiveSortTypes - types of the sorted arrays

associatedTypes - types of the associated arrays

exampleArrays - examples for the different array types

Throws:

IOException

writeTestMethod

private void writeTestMethod(String sortedType,
                             String sortedTypeExample,
                             String associatedType,
                             String associatedTypeExample)
                      throws IOException

writes the test method for a single combination of a sorted array type and an associated array type.

Parameters:

sortedType - type of the sorted array

sortedTypeExample - already sorted example of the sorted array type

associatedType - type of the associated array

associatedTypeExample - example of the associated array type

Throws:

IOException

getArrayDelta

private String getArrayDelta(String type)

Returns a String defining a delta for the equal assertion of the JUnit tests if the given type is double or float. Else an empty String is returned.

Parameters:

type -

Returns: