com.highqsoft.ascoba

Class CompareModelDoxygen

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.ascoba.CompareModelDoxygen

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class CompareModelDoxygen
extends AbstractImplementation
implements ExecutableIF

This implementation compare the model of the ASAM ODS source with the model of the ASAM ODS target. For more details see \ref implementations_com_highqsoft_ascoba_CompareModelDoxygen

Since:

$Date: 2017/04/06 13:28:20 $ Modification History: $Log: CompareModelDoxygen.java,v $ Revision 1.5 2017/04/06 13:28:20 adil update copyright. Revision 1.4 2015/05/20 13:06:23 karst Update Copyrights to current. Revision 1.3 2014/11/07 14:24:23 karst Correct error messages. Revision 1.2 2013/01/03 09:51:40 karst Update copyright to 2013. Revision 1.1 2012/02/14 17:01:03 karst Initial CSV version after move directory.

Version:

$Revision: 1.5 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected AoSession	sourceSess The ASAM ODS session of the source.
protected AoSession	targetSess The ASAM ODS session of the target.

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
CompareModelDoxygen()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	compareAttribute(java.io.PrintWriter pw, ApplicationElement ae, ApplicationElement aeTarget, ApplicationAttribute aa, java.lang.String source, java.lang.String target, boolean targetCompare) Compare the attributes from the ASAM ODS services.
protected void	compareElement(java.io.PrintWriter pw, ApplicationElement ae, ApplicationStructure target, AoSession targetSession) Compare the application element from the source with the element in the target.
protected void	compareEnumeration(java.io.PrintWriter pw, EnumerationDefinition ed, EnumerationDefinition edTarget, java.lang.String source, java.lang.String target) Compare the enumeration definitions from two ODS services.
protected boolean	compareRelation(java.io.PrintWriter pw, ApplicationElement ae, ApplicationElement aeTarget, ApplicationRelation ar, java.lang.String source, java.lang.String target, boolean targetCompare) Compare the relation of an element with the relation from the target element.
void	execute() The execute method, copy the model from the source session into the target session.
protected ApplicationRelation	getRelationByName(ApplicationElement ae, java.lang.String arName) Get the application relation defined by the relation name.
void	init() Initialize the copy of the model
protected void	printBaseAttribute(java.io.PrintWriter pw, InstanceElement ie, java.lang.String baName) Print a value of the instance element
protected void	printSession(java.io.PrintWriter pw, AoSession session) Print the information of the session for the model description.
void	terminate() The terminate method, nothing to do.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

sourceSess

protected AoSession sourceSess

The ASAM ODS session of the source.

targetSess

protected AoSession targetSess

The ASAM ODS session of the target.

Constructor Detail

CompareModelDoxygen

public CompareModelDoxygen()

Method Detail

printBaseAttribute

protected void printBaseAttribute(java.io.PrintWriter pw,
                      InstanceElement ie,
                      java.lang.String baName)

Print a value of the instance element

Parameters:

pw - the writer

ie - the instance element

baName - the base attribute name of the value to print.

printSession

protected void printSession(java.io.PrintWriter pw,
                AoSession session)

Print the information of the session for the model description.

Parameters:

pw - the writer

session - the session.

execute

public void execute()
             throws ExecutableException

The execute method, copy the model from the source session into the target session.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

See Also:

ExecutableIF.execute()

terminate

public void terminate()
               throws TerminationException

The terminate method, nothing to do.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

See Also:

ExecutableIF.terminate()

init

public void init()
          throws InitializationFailedException

Initialize the copy of the model

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - - When one of the required arguments not exist.

See Also:

com.highqsoft.xsd.ImplentationIF#init()

compareEnumeration

protected void compareEnumeration(java.io.PrintWriter pw,
                      EnumerationDefinition ed,
                      EnumerationDefinition edTarget,
                      java.lang.String source,
                      java.lang.String target)
                           throws AoException

Compare the enumeration definitions from two ODS services.

Parameters:

pw - the writer

ed - enumeration definition from the source.

edTarget - enumeration definition from the target

source - the name of the source

target - the name of the target

Throws:

AoException - any occurring ASAM ODS Exception

compareAttribute

protected boolean compareAttribute(java.io.PrintWriter pw,
                       ApplicationElement ae,
                       ApplicationElement aeTarget,
                       ApplicationAttribute aa,
                       java.lang.String source,
                       java.lang.String target,
                       boolean targetCompare)
                            throws AoException

Compare the attributes from the ASAM ODS services.

Parameters:

pw - the writer

ae - element from the source services.

aeTarget - element from the target services.

aa - the application attribute from the source services.

source - the name of the source.

target - the name of the target

targetCompare - compare the attribute of the target.

Returns:

true if a difference is found

Throws:

AoException - any occurring ASAM ODS exception.

compareElement

protected void compareElement(java.io.PrintWriter pw,
                  ApplicationElement ae,
                  ApplicationStructure target,
                  AoSession targetSession)
                       throws AoException

Compare the application element from the source with the element in the target. The difference are written to the writer.

Parameters:

pw - the writer.

ae - the application element to copy.

target - the target application structure

targetSession - the target session

Throws:

AoException - any occurring exception.

getRelationByName

protected ApplicationRelation getRelationByName(ApplicationElement ae,
                                    java.lang.String arName)
                                         throws AoException

Get the application relation defined by the relation name.

Parameters:

ae - the application element.

arName - the relation name

Returns:

the found application relation or null when not found.

Throws:

AoException - any occurring ASAM ODS Exception.

compareRelation

protected boolean compareRelation(java.io.PrintWriter pw,
                      ApplicationElement ae,
                      ApplicationElement aeTarget,
                      ApplicationRelation ar,
                      java.lang.String source,
                      java.lang.String target,
                      boolean targetCompare)
                           throws AoException

Compare the relation of an element with the relation from the target element.

Parameters:

pw - the writer

ae - the application element from the source.

aeTarget - the application element from the target.

ar - the relation from the source.

source - the name of the source

target - the name of the target

targetCompare - is the compare on a target relation

Returns:

true if a difference ist found

Throws:

AoException - any occurring ASAM ODS exception.