Added few doc lines.
This commit is contained in:
parent
7d14230745
commit
bd9bfadeb4
|
@ -39,7 +39,7 @@ import org.x4o.xml.lang.X4OLanguage;
|
||||||
import org.xml.sax.SAXException;
|
import org.xml.sax.SAXException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* EldXsdWriter creates XML Schema files fom a x4o language.
|
* EldXsdWriter creates XML Schema files from a x4o language.
|
||||||
*
|
*
|
||||||
* @author Willem Cazander
|
* @author Willem Cazander
|
||||||
* @version 1.0 Aug 8, 2012
|
* @version 1.0 Aug 8, 2012
|
||||||
|
|
|
@ -32,7 +32,7 @@ import org.x4o.xml.element.ElementNamespace;
|
||||||
import org.x4o.xml.lang.phase.X4OPhaseManager;
|
import org.x4o.xml.lang.phase.X4OPhaseManager;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* X4OLanguage hold the defined language.
|
* X4OLanguage hold all the base definition properties of x4o xml language.
|
||||||
*
|
*
|
||||||
* @author Willem Cazander
|
* @author Willem Cazander
|
||||||
* @version 1.0 30 apr 2013
|
* @version 1.0 30 apr 2013
|
||||||
|
@ -40,23 +40,24 @@ import org.x4o.xml.lang.phase.X4OPhaseManager;
|
||||||
public interface X4OLanguage {
|
public interface X4OLanguage {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the language for which this ElementLanguage is created.
|
* Returns the language name of this x4o xml language.
|
||||||
* @return Returns the language.
|
* @return Returns the language name.
|
||||||
*/
|
*/
|
||||||
String getLanguageName();
|
String getLanguageName();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return Returns the languageVersion of the parsing of this language.
|
* @return Returns the language version of this language instance.
|
||||||
*/
|
*/
|
||||||
String getLanguageVersion();
|
String getLanguageVersion();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return the X4OPhaseManager.
|
* Returns the phase manager which runs the phases
|
||||||
|
* @return Returns the phase manager.
|
||||||
*/
|
*/
|
||||||
X4OPhaseManager getPhaseManager();
|
X4OPhaseManager getPhaseManager();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return the languageConfiguration.
|
* @return the language configuration.
|
||||||
*/
|
*/
|
||||||
X4OLanguageConfiguration getLanguageConfiguration();
|
X4OLanguageConfiguration getLanguageConfiguration();
|
||||||
|
|
||||||
|
|
|
@ -41,6 +41,9 @@ import org.x4o.xml.lang.phase.X4OPhase;
|
||||||
*/
|
*/
|
||||||
public interface X4OLanguageSession {
|
public interface X4OLanguageSession {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Returns the language from which this session in created.
|
||||||
|
*/
|
||||||
X4OLanguage getLanguage();
|
X4OLanguage getLanguage();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -90,7 +93,6 @@ public interface X4OLanguageSession {
|
||||||
*/
|
*/
|
||||||
void setRootElement(Element element);
|
void setRootElement(Element element);
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return Returns null or an X4ODebugWriter to write parsing steps and debug data to.
|
* @return Returns null or an X4ODebugWriter to write parsing steps and debug data to.
|
||||||
*/
|
*/
|
||||||
|
@ -107,7 +109,13 @@ public interface X4OLanguageSession {
|
||||||
*/
|
*/
|
||||||
X4OPhase getPhaseCurrent();
|
X4OPhase getPhaseCurrent();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Returns the phase this session will stop processing.
|
||||||
|
*/
|
||||||
public String getPhaseStop();
|
public String getPhaseStop();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Returns a list of phases we skip while processing.
|
||||||
|
*/
|
||||||
public List<String> getPhaseSkip();
|
public List<String> getPhaseSkip();
|
||||||
}
|
}
|
||||||
|
|
|
@ -32,11 +32,29 @@ import org.x4o.xml.io.sax.ext.PropertyConfig;
|
||||||
*/
|
*/
|
||||||
public interface X4OLanguageTask {
|
public interface X4OLanguageTask {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Returns the task id.
|
||||||
|
*/
|
||||||
String getId();
|
String getId();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Returns the task name.
|
||||||
|
*/
|
||||||
String getName();
|
String getName();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Returns the task description.
|
||||||
|
*/
|
||||||
String getDescription();
|
String getDescription();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Returns newly created PropertyConfig for configuring this task.
|
||||||
|
*/
|
||||||
PropertyConfig createTaskConfig();
|
PropertyConfig createTaskConfig();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param config The config with which the task will be runned.
|
||||||
|
* @return The task executor for running the task.
|
||||||
|
*/
|
||||||
X4OLanguageTaskExecutor createTaskExecutor(PropertyConfig config);
|
X4OLanguageTaskExecutor createTaskExecutor(PropertyConfig config);
|
||||||
}
|
}
|
||||||
|
|
|
@ -33,5 +33,10 @@ import org.x4o.xml.lang.X4OLanguage;
|
||||||
*/
|
*/
|
||||||
public interface X4OLanguageTaskExecutor {
|
public interface X4OLanguageTaskExecutor {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Executes a task for which this executor is created.
|
||||||
|
* @param language The language for which we run the task.
|
||||||
|
* @throws X4OLanguageTaskException Can be thrown in case of error.
|
||||||
|
*/
|
||||||
void execute(X4OLanguage language) throws X4OLanguageTaskException;
|
void execute(X4OLanguage language) throws X4OLanguageTaskException;
|
||||||
}
|
}
|
||||||
|
|
|
@ -38,7 +38,7 @@ import org.x4o.xml.lang.task.X4OLanguageTaskExecutor;
|
||||||
* @author Willem Cazander
|
* @author Willem Cazander
|
||||||
* @version 1.0 Aug 30, 2013
|
* @version 1.0 Aug 30, 2013
|
||||||
*/
|
*/
|
||||||
public class X4OTaskRunner {
|
public final class X4OTaskRunner {
|
||||||
|
|
||||||
static public void runTask(String languageName,String languageVersion,String taskId,List<X4OTaskProperty> props) throws X4OLanguageTaskException {
|
static public void runTask(String languageName,String languageVersion,String taskId,List<X4OTaskProperty> props) throws X4OLanguageTaskException {
|
||||||
X4ODriver<?> driver = X4ODriverManager.getX4ODriver(languageName);
|
X4ODriver<?> driver = X4ODriverManager.getX4ODriver(languageName);
|
||||||
|
|
Loading…
Reference in a new issue