/**
* Parses the given {@link de.xirp.profile.Robot robot} file and returns the resulting {@link
* de.xirp.profile.Robot robot} bean. <br>
* <br>
* This method calls the {@link de.xirp.profile.ProfileParser#parseComSpec(String)} method for all
* available {@link de.xirp.profile.CommunicationSpecification comm-spec} file names from the just
* created {@link de.xirp.profile.Robot robot} object. At return time of the method the returned
* {@link de.xirp.profile.Robot robot} is complete including the {@link
* de.xirp.profile.CommunicationSpecification comm-specs}.
*
* @param fileName The XML robot file name (without postfix and path).
* @param factory The factory which is used to load the XML schema definition used for validating
* the XML.
* @return the parsed robot or <code>null</code> if an error occurred.
* @see de.xirp.profile.Robot
* @see de.xirp.profile.CommunicationSpecification
*/
private static Robot parseRobot(String fileName, SchemaFactory factory) {
if (!Util.isEmpty(fileName)) {
try {
JAXBContext jc = JAXBContext.newInstance(Robot.class);
Unmarshaller um = jc.createUnmarshaller();
try {
Schema schema = factory.newSchema(new File(Constants.CONF_ROBOTS_XML_SCHEMA));
um.setSchema(schema);
} catch (SAXException e) {
logClass.error(
"Error: "
+ e.getMessage()
+ //$NON-NLS-1$
Constants.LINE_SEPARATOR,
e);
}
Robot robot =
(Robot)
um.unmarshal(
new File(
Constants.CONF_ROBOTS_DIR
+ File.separator
+ fileName
+ Constants.ROBOT_POSTFIX));
String cmsFileName = robot.getCommSpecFileName();
CommunicationSpecification comSpec = parseComSpec(cmsFileName, factory);
if (comSpec.isComplete()) {
robot.setCommunicationSpecification(comSpec);
} else {
logClass.warn(
Constants.LINE_SEPARATOR
+ I18n.getString(
"ProfileParser.log.comspecNotCompleted", //$NON-NLS-1$
Constants.LINE_SEPARATOR,
(cmsFileName + Constants.COMM_SPEC_POSTFIX))
+ Constants.LINE_SEPARATOR);
}
robot.setBotFile(new File(Constants.CONF_ROBOTS_DIR, fileName));
return robot;
} catch (JAXBException e) {
logClass.error("Error " + e.getMessage() + Constants.LINE_SEPARATOR, e);
return null;
}
} else {
return null;
}
}
/**
* Parses the given {@link de.xirp.profile.Profile profile} file and returns the resulting {@link
* de.xirp.profile.Profile profile} bean. <br>
* <br>
* This method calls the {@link de.xirp.profile.ProfileParser#parseRobot(String)} parsing method
* for the robot file names available in the just created {@link de.xirp.profile.Profile profile}
* bean. At return time of this method the {@link de.xirp.profile.Profile profile} is complete,
* including {@link de.xirp.profile.Robot robots} and {@link
* de.xirp.profile.CommunicationSpecification comm-specs}.
*
* @param xmlFile The XML profile file.
* @return The parsed profile bean.
* @throws JAXBException if something went wrong while parsing.
* @see de.xirp.profile.Profile profile
* @see de.xirp.profile.Robot
* @see de.xirp.profile.CommunicationSpecification
*/
private static Profile parseProfile(File xmlFile) throws JAXBException {
logClass.info(
I18n.getString("ProfileParser.log.parsing.profile", xmlFile)
+ //$NON-NLS-1$
Constants.LINE_SEPARATOR);
SchemaFactory factory = getFactory();
JAXBContext jc = JAXBContext.newInstance(Profile.class);
Unmarshaller um = jc.createUnmarshaller();
try {
Schema schema = factory.newSchema(new File(Constants.CONF_PROFILES_XML_SCHEMA));
um.setSchema(schema);
} catch (SAXException e) {
logClass.error(
"Error: "
+ e.getMessage()
+ //$NON-NLS-1$
Constants.LINE_SEPARATOR,
e);
}
Profile profile = (Profile) um.unmarshal(xmlFile);
for (String robotName : profile.getRobotFileNames()) {
Robot robot = parseRobot(robotName, factory);
if (robot != null) {
if (robot.isComplete()) {
profile.addRobot(robot);
} else {
logClass.warn(
Constants.LINE_SEPARATOR
+ I18n.getString(
"ProfileParser.log.robotNotCompleted", //$NON-NLS-1$
robot.getName(),
Constants.LINE_SEPARATOR,
(robotName + Constants.ROBOT_POSTFIX))
+ Constants.LINE_SEPARATOR);
}
}
}
return profile;
}
/**
* Initializes all auxiliary data structures. First the {@link de.xirp.profile.Profile profile}
* beans are parsed. After that, all same named {@link de.xirp.profile.Profile profiles} obtain a
* unique name. The incomplete {@link de.xirp.profile.Profile profiles} are added to the
* corresponding map and the complete {@link de.xirp.profile.Profile profiles} are also added to
* their corresponding map. <br>
* <br>
* After that step, the {@link de.xirp.profile.Robot robot} beans are created by the parser for
* each {@link de.xirp.profile.Profile profile}. The {@link de.xirp.profile.Robot robots} are
* created and added to the corresponding {@link java.util.Vector vector} in the {@link
* de.xirp.profile.Profile profiles}. While parsing the {@link de.xirp.profile.Robot robots} the
* contained {@link de.xirp.profile.CommunicationSpecification comm-spec} beans are parsed and
* added to the corresponding {@link java.util.Vector vector} in the {@link de.xirp.profile.Robot
* robot}. After all {@link de.xirp.profile.Robot robots} have been created, all same named {@link
* de.xirp.profile.Robot robots} obtain a unique name. <br>
* <br>
* All {@link de.xirp.profile.Profile profiles} and {@link de.xirp.profile.Robot robots} obtain
* unique names to guarantee that {@link de.xirp.profile.Profile profiles} and {@link
* de.xirp.profile.Robot robots} can be clearly identified. The unique names are achieved by
* enumerating the same named objects.
*
* @throws JAXBException if something went wrong while parsing.
* @see de.xirp.profile.Robot
* @see de.xirp.profile.Profile
* @see de.xirp.profile.CommunicationSpecification
*/
private void init() throws JAXBException {
logClass.info(I18n.getString("ProfileParser.log.parsing")); // $NON-NLS-1$
File profDir = new File(Constants.CONF_PROFILES_DIR);
File dtdP =
new File(Constants.CONF_PROFILES_DIR + File.separator + "profile.dtd"); // $NON-NLS-1$
File dtdC =
new File(
Constants.CONF_COMMSPECS_DIR + File.separator + "communication.dtd"); // $NON-NLS-1$
File dtdR = new File(Constants.CONF_ROBOTS_DIR + File.separator + "robot.dtd"); // $NON-NLS-1$
if (!dtdP.exists()) {
try {
throw new FileNotFoundException(
I18n.getString("ProfileParser.log.noProfilesDTD", dtdP.getName())); // $NON-NLS-1$
} catch (FileNotFoundException e) {
logClass.info(
I18n.getString("ProfileParser.log.failed") + Constants.LINE_SEPARATOR); // $NON-NLS-1$
logClass.error(
"Error: "
+ e.getMessage() // $NON-NLS-1$
+ Constants.LINE_SEPARATOR,
e);
}
} else if (!dtdC.exists()) {
try {
throw new FileNotFoundException(
I18n.getString("ProfileParser.log.noProfilesDTD", dtdC.getName())); // $NON-NLS-1$
} catch (FileNotFoundException e) {
logClass.info(
I18n.getString("ProfileParser.log.failed") + Constants.LINE_SEPARATOR); // $NON-NLS-1$
logClass.error(
"Error: "
+ e.getMessage() // $NON-NLS-1$
+ Constants.LINE_SEPARATOR,
e);
}
} else if (!dtdR.exists()) {
try {
throw new FileNotFoundException(
I18n.getString("ProfileParser.log.noProfilesDTD", dtdR.getName())); // $NON-NLS-1$
} catch (FileNotFoundException e) {
logClass.info(
I18n.getString("ProfileParser.log.failed") + Constants.LINE_SEPARATOR); // $NON-NLS-1$
logClass.error(
"Error: "
+ e.getMessage() // $NON-NLS-1$
+ Constants.LINE_SEPARATOR,
e);
}
}
File[] files =
profDir.listFiles(
new FilenameFilter() {
public boolean accept(File dir, String name) {
return name.endsWith(Constants.PROFILE_POSTFIX);
}
});
if (files.length <= 0) {
try {
throw new FileNotFoundException(
I18n.getString("ProfileParser.exception.noProfilesFound")); // $NON-NLS-1$
} catch (FileNotFoundException e) {
logClass.info(
I18n.getString("ProfileParser.log.failed") // $NON-NLS-1$
+ Constants.LINE_SEPARATOR
+ e.getMessage()
+ Constants.LINE_SEPARATOR);
logClass.info(
I18n.getString("ProfileParser.log.noProfilesLoaded") // $NON-NLS-1$
+ Constants.LINE_SEPARATOR);
}
}
MultiValueHashMap<String, Profile> profileNames = new MultiValueHashMap<String, Profile>();
Profile profile;
for (File xmlFile : files) {
profile = parseProfile(xmlFile);
profile.setProFile(xmlFile);
profileNames.put(profile.getName(), profile);
}
List<Profile> prfls = new ArrayList<Profile>();
for (Entry<String, List<Profile>> e : profileNames.entrySet()) {
List<Profile> list = e.getValue();
if (list.size() > 1) {
for (int i = 0; i < list.size(); i++) {
Profile aux = list.get(i);
aux.setName(aux.getName() + " #" + (i + 1)); // $NON-NLS-1$
prfls.add(aux);
}
} else {
prfls.add(list.get(0));
}
}
MultiValueHashMap<String, Robot> robotNames = new MultiValueHashMap<String, Robot>();
for (Profile p : prfls) {
for (Robot r : p.getRobots()) {
robotNames.put(r.getName(), r);
}
}
for (Entry<String, List<Robot>> e : robotNames.entrySet()) {
List<Robot> list = e.getValue();
if (list.size() > 1) {
for (int i = 0; i < list.size(); i++) {
Robot aux = list.get(i);
aux.setName(aux.getName() + " #" + (i + 1)); // $NON-NLS-1$
}
}
}
for (Profile p : prfls) {
if (p.isComplete()) {
profiles.put(p.getName(), p);
} else {
incompleteProfiles.put(p.getName(), p);
}
}
}
/**
* Compares to robots. The robots are compared by their name.
*
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
public int compareTo(Robot r) {
return getName().compareToIgnoreCase(r.getName());
}