MusicXML Tasks: Application Use

Application Use

You can use the Java code in your application by placing the musicxmltasks.jar in the classpath of your application.

The jar file is available here.

The jar file without dependencies is available here.

Java class structure

You can navigate the Java class structure using the application's Javadoc. Navigate to the Javadoc section in the left nav. The top-level MusicXML Java class is the Score class.

Converting MusicXML to Java

Converting a MusicXML file to Java requires calling one statement:

import com.musicxmltasks.musicxml.score.Score;
import com.musicxmltasks.musicxml.util.MusicXmlUtil;
import com.musicxmltasks.xml.XmlException;

try {
    String xmlFilename = "...";
    // get the score
    Score score = MusicXmlUtil.getScoreFromMusicXmlFile(xmlFilename);
} catch (XmlException e) {
    // handle exception
}

Converting Java to MusicXML

You can construct MusicXML Java and convert it to XML as in the following:

import com.musicxmltasks.musicxml.attributes.Attributes;
import com.musicxmltasks.musicxml.exception.MusicXmlException;
import com.musicxmltasks.musicxml.note.Note;
import com.musicxmltasks.musicxml.score.Measure;
import com.musicxmltasks.musicxml.score.Part;
import com.musicxmltasks.musicxml.score.Score;
import com.musicxmltasks.musicxml.util.MusicXmlUtil;
import com.musicxmltasks.xml.SchemaValidator;
import com.musicxmltasks.xml.XmlException;
import org.w3c.dom.Document;

try {
    // build the score and its components
    Score score = new Score();

    // set parts for the score
    Part part = new Part();
    score.getParts().add(part);

    // set measures for the part
    Measure measure = new Measure();
    // set Measure values ....
    part.getMeasure().add(measure);

    // set MusicData items for the measure
    Attributes attributes = new Attributes();
    // set Attributes values ....
    measure.getMusicDataList().add(attributes);

    Note note = new Note();
    // set Note values ....
    measure.getMusicDataList().add(note);

    // continue setting values in the Score ....

    // create an XML Document from the score
    Document document = MusicXmlUtil.getDocumentFromScore(score);

    // if you want to validate the document
    SchemaValidator.getInstance().validate(document);

    // if you want to indent the document
    String results = MusicXmlUtil.getFormattedXml(document, score);

    // if you want to write the XML to file
    String outputFilename = "...";
    FileUtil.stringToFile(results, outputFilename);
} catch (XmlException | MusicXmlException | FileException e) {
    // handle exception
}