Skip navigation links
LuciadLightspeed
2020.1.21
com.luciad.format.aixm.decoder

Aviation StandardsClass TLcdAIXMProcedureHandler

    • Constructor Detail

      • TLcdAIXMProcedureHandler

        public TLcdAIXMProcedureHandler()
        Creates a new TLcdAIXMProcedureHandler.
    • Method Detail

      • startElement

        public void startElement(java.lang.String aElementName,
                                 ILcdAssocSet aAttributes,
                                 java.util.Stack aElementStack)
        Description copied from interface: ILcdAIXMHandler
        Receive notification of the beginning of an AIXM element.

        This method will be invoked at the beginning of every element in the AIXM document; there will be a corresponding endElement event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.

        The attributes attached to the element are available through an immutable ILcdAssocSet. Only the following methods of the interface are available:

        • public int size()
        • public boolean hasValue(Object aObject)
        • public Object getValue(Object aKey)
        • public Enumeration keys()
        • public Enumeration elements()
        An UnsupportedOperationException will be thrown if one of the other methods are called.
        Parameters:
        aElementName - The name of the element.
        aAttributes - The attributes attached to the element.
        aElementStack - A stack containing the element names of all the parents of the current element and itself.
        See Also:
        ILcdAIXMHandler.endElement(java.lang.String, java.lang.String, java.util.Stack)
      • endElement

        public void endElement(java.lang.String aElementName,
                               java.lang.String aContent,
                               java.util.Stack aElementStack)
        Description copied from interface: ILcdAIXMHandler
        Receive notification of the end of an AIXM element.

        This method will be invoked at the end of every element in the AIXM document; there will be a corresponding startElement event for every endElement event (even when the element is empty).

        Parameters:
        aElementName - The name of the element.
        aContent - The contents of the current element, or the empty string if the element was empty.
        aElementStack - A stack containing the element names of all the parents of the current element and itself.
      • getProcedureFeatureNamesToBeDecoded

        public java.lang.String[] getProcedureFeatureNamesToBeDecoded()
        Returns the AIXM procedure features which are decoded into the featured model objects.
        Returns:
        the AIXM procedure features which are decoded into the featured model objects.
      • setProcedureFeatureNamesToBeDecoded

        public void setProcedureFeatureNamesToBeDecoded(java.lang.String[] aProcedureFeatureNamesToBeDecoded)
        Sets the AIXM procedure features which need to be decoded into the featured model objects. By default, all available features are decoded.

        Note that AIXM handlers rely on a specific set of key features that uniquely define an object. This set of features must always be included in the set of features to be decoded. See the class documentation for the key feature list of this handler.

        Parameters:
        aProcedureFeatureNamesToBeDecoded - the AIXM procedure features which need to be decoded into the featured model objects.
      • getProcedureLegFeatureNamesToBeDecoded

        public java.lang.String[] getProcedureLegFeatureNamesToBeDecoded()
        Returns the AIXM procedure leg features which are decoded into the featured model objects.
        Returns:
        the AIXM procedure leg features which are decoded into the featured model objects.
      • setProcedureLegFeatureNamesToBeDecoded

        public void setProcedureLegFeatureNamesToBeDecoded(java.lang.String[] aProcedureLegFeatureNamesToBeDecoded)
        Sets the AIXM procedure leg features which need to be decoded into the featured model objects. By default, all available features are decoded.
        Parameters:
        aProcedureLegFeatureNamesToBeDecoded - the AIXM procedure leg features which need to be decoded into the featured model objects.
      • newModel

        public void newModel(java.lang.String aSource,
                             ILcdAIXMErrorMessageSupport aErrorMessage)
        Description copied from interface: ILcdAIXMHandler
        Resets the internal state of this handler so that it is ready to handle a new data source from scratch.

        The user should call this method before using this handler in a decoding process of an AIXM snapshot.

        Specified by:
        newModel in interface ILcdAIXMHandler
        Parameters:
        aSource - the name of the source that will be handled
        aErrorMessage - for each irregular situation during the decoding, a report should be added to this object
      • setModelToUpdate

        public boolean setModelToUpdate(java.lang.String aSource,
                                        ILcdModel aModel,
                                        ILcdAIXMErrorMessageSupport aErrorMessage)
        Description copied from interface: ILcdAIXMHandler
        Sets the internal state of this handler so that it is ready to update the given model with a new data source.

        The user should call this method before using this handler in a decoding process of an AIXM update.

        Specified by:
        setModelToUpdate in interface ILcdAIXMHandler
        Parameters:
        aSource - the name of the source that will be handled
        aModel - the model that must be updated
        aErrorMessage - for each irregular situation during the decoding, a report should be added to this object
      • setDomainFactory

        @Deprecated
        public void setDomainFactory(ALcdAISObjectFactory aDomainFactory)
        Deprecated. 
        Description copied from interface: ILcdAIXMHandler
        Specifies the domainFactory to be used to create domain objects.

        The given domainFactory must not be null. Note that if a data object factory is set, the domain factory will not be used.

        Specified by:
        setDomainFactory in interface ILcdAIXMHandler
        Parameters:
        aDomainFactory - the domainFactory to be used to create domain objects
        See Also:
        ILcdAIXMHandler.getDomainFactory()
      • updateModel

        public void updateModel()
        Description copied from interface: ILcdAIXMHandler
        Applies the updates that are read to the model.

        Please remark that this handler is only capable of updating the model if the user calls

        Specified by:
        updateModel in interface ILcdAIXMHandler
      • setBoundsToFilterOn

        public void setBoundsToFilterOn(ILcdBounds aBoundsToFilterOn)
        Description copied from interface: ILcdAIXMHandler
        Specifies a bounds that will be used as a filter on the model created by this handler.

        If this bounds is null, all objects found in the data source will be inserted into the model. If this bounds is not null, only the objects whose bounds interact with the specified bounds will be inserted into the model.

        Specified by:
        setBoundsToFilterOn in interface ILcdAIXMHandler
        Parameters:
        aBoundsToFilterOn - the bounds to be used as a filter
      • setInitialBounds

        public void setInitialBounds(ILcdBounds aInitialBounds)
        Description copied from interface: ILcdAIXMHandler
        Specifies a bounds to be used as initial bounds for the model created by this handler.

        This bounds should be large enough to enclose (most of) the model objects. This option is used to avoid to many expansions of the model bounds.

        This parameter may be null.

        Note: This bounds is not a filter! If a model objects bounds does not interact with aInitialBounds, aInitialBounds will be enlarged to enclose the object.

        Specified by:
        setInitialBounds in interface ILcdAIXMHandler
        Parameters:
        aInitialBounds - the initial bounds for the model created by this handler
      • setAIXMModelFilter

        public void setAIXMModelFilter(ILcdAIXMModelFilter aFilter)
        Description copied from interface: ILcdAIXMHandler
        Specifies a filter to be used while creating the model. Only model objects that pass through the filter will be in the resulting model.
        Specified by:
        setAIXMModelFilter in interface ILcdAIXMHandler
        Parameters:
        aFilter - an ILcdAIXMModelFilter to filter the model objects
      • getAIXMModelFilter

        public ILcdAIXMModelFilter getAIXMModelFilter()
        Returns the currently registered filter.
        Returns:
        the currently registered filter (can be null).
      • getElementsToBeHandled

        public java.lang.String[] getElementsToBeHandled()
        Description copied from interface: ILcdAIXMHandler
        Returns the elements for which the methods startElement and endElement should be invoked.

        These elements must be a direct child of one of the following AIXM elements:

        • AIXM-Snapshot
        • Changed
        • New
        • Withdrawn
        See the AIXM XML Schema documents for a list of possible childs.
        Specified by:
        getElementsToBeHandled in interface ILcdAIXMHandler
        Returns:
        A String array containing the elements for which the methods startElement and endElement should be invoked.
      • isTraceOn

        public boolean isTraceOn()
        Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
        Returns true if tracing is enabled for this class.
        Returns:
        true if tracing is enabled for this class, false otherwise.
      • setClassTraceOn

        public static void setClassTraceOn(boolean aClassTraceOn)
        Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
        Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
        Parameters:
        aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
      • setTraceOn

        public void setTraceOn(boolean aTraceOn)
        Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
        Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.
        Parameters:
        aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.
LuciadLightspeed
2020.1.21