Package com.sas.metadata.remote

Interface XPath

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface XPath extends SecondaryType
Used to describe an XPath location path.

Attributes of XPath are:

Associations of XPath are:

Usage

To create an instance of this XPath, use the factory create methods.
Example: create a XPath with name "XPath_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 XPath myObject = (XPath) factory.createComplexMetadataObject(objectStore, "XPath_Object", MetadataObjects.XPATH, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_LOCATIONPATH_NAME

      static final String ATTRIBUTE_LOCATIONPATH_NAME
      Constant used for the name of the LocationPath attribute.

      LocationPath: LocationPath

      See Also:

    • ATTRIBUTE_LOCATIONPATHTYPE_NAME

      static final String ATTRIBUTE_LOCATIONPATHTYPE_NAME
      Constant used for the name of the LocationPathType attribute.

      LocationPathType: Indicates if the path is absolute (0) or relative (1).

      See Also:

    • ATTRIBUTE_MAJORVERSION_NAME

      static final String ATTRIBUTE_MAJORVERSION_NAME
      Constant used for the name of the MajorVersion attribute.

      MajorVersion: Major version of the SAS XML LIBNAME extension.

      See Also:

    • ATTRIBUTE_MINORVERSION_NAME

      static final String ATTRIBUTE_MINORVERSION_NAME
      Constant used for the name of the MinorVersion attribute.

      MinorVersion: Minor version of the SAS XML LIBNAME extension.

      See Also:

    • ATTRIBUTE_PROCESSTAG_NAME

      static final String ATTRIBUTE_PROCESSTAG_NAME
      Constant used for the name of the ProcessTag attribute.

      ProcessTag: Integer to show whether the tag is the beginning or the end of an Xpath. 0 = no tag; 1= beginning tag; 2 = end tag

      See Also:

    • ATTRIBUTE_AXISNAME_NAME

      static final String ATTRIBUTE_AXISNAME_NAME
      Constant used for the name of the AxisName attribute.

      AxisName: Used to show the tree relationship.

      See Also:

    • ATTRIBUTE_NODESETFUNCTION_NAME

      static final String ATTRIBUTE_NODESETFUNCTION_NAME
      Constant used for the name of the NodeSetFunction attribute.

      NodeSetFunction: Used to show the node set function.

      See Also:

    • ATTRIBUTE_SYNTAXMARKER_NAME

      static final String ATTRIBUTE_SYNTAXMARKER_NAME
      Constant used for the name of the SyntaxMarker attribute.

      SyntaxMarker: Describes the language used in the XPath.

      See Also:

    • ASSOCIATION_ASSOCIATEDMAPCOLUMN_NAME

      static final String ASSOCIATION_ASSOCIATEDMAPCOLUMN_NAME
      Constant used for the name of the AssociatedMapColumn association.

      AssociatedMapColumn: Associated SXLE map column. 

      See Also:

    • ASSOCIATION_ASSOCIATEDMAPTABLE_NAME

      static final String ASSOCIATION_ASSOCIATEDMAPTABLE_NAME
      Constant used for the name of the AssociatedMapTable association.

      AssociatedMapTable: Associated SXLE map table. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationPath

      String getLocationPath() throws RemoteException
      Gets the String value of LocationPath
      Returns:
      The LocationPath
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationPathState

      int getLocationPathState() throws RemoteException
      Gets the Metadata State of LocationPath
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationPathMaxLength

      int getLocationPathMaxLength() throws RemoteException
      Gets the maximum length of LocationPath
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationPathType

      int getLocationPathType() throws RemoteException
      Gets the int value of LocationPathType
      Returns:
      The LocationPathType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationPathTypeState

      int getLocationPathTypeState() throws RemoteException
      Gets the Metadata State of LocationPathType
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getMajorVersion

      int getMajorVersion() throws RemoteException
      Gets the int value of MajorVersion
      Returns:
      The MajorVersion
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getMajorVersionState

      int getMajorVersionState() throws RemoteException
      Gets the Metadata State of MajorVersion
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getMinorVersion

      int getMinorVersion() throws RemoteException
      Gets the int value of MinorVersion
      Returns:
      The MinorVersion
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getMinorVersionState

      int getMinorVersionState() throws RemoteException
      Gets the Metadata State of MinorVersion
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getProcessTag

      int getProcessTag() throws RemoteException
      Gets the int value of ProcessTag
      Returns:
      The ProcessTag
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getProcessTagState

      int getProcessTagState() throws RemoteException
      Gets the Metadata State of ProcessTag
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAxisName

      String getAxisName() throws RemoteException
      Gets the String value of AxisName
      Returns:
      The AxisName
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAxisNameState

      int getAxisNameState() throws RemoteException
      Gets the Metadata State of AxisName
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAxisNameMaxLength

      int getAxisNameMaxLength() throws RemoteException
      Gets the maximum length of AxisName
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getNodeSetFunction

      String getNodeSetFunction() throws RemoteException
      Gets the String value of NodeSetFunction
      Returns:
      The NodeSetFunction
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getNodeSetFunctionState

      int getNodeSetFunctionState() throws RemoteException
      Gets the Metadata State of NodeSetFunction
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getNodeSetFunctionMaxLength

      int getNodeSetFunctionMaxLength() throws RemoteException
      Gets the maximum length of NodeSetFunction
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getSyntaxMarker

      String getSyntaxMarker() throws RemoteException
      Gets the String value of SyntaxMarker
      Returns:
      The SyntaxMarker
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getSyntaxMarkerState

      int getSyntaxMarkerState() throws RemoteException
      Gets the Metadata State of SyntaxMarker
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getSyntaxMarkerMaxLength

      int getSyntaxMarkerMaxLength() throws RemoteException
      Gets the maximum length of SyntaxMarker
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAssociatedMapColumns

      AssociationList getAssociatedMapColumns() throws RemoteException, MdException
      Gets the Association list of AssociatedMapColumns
      Returns:
      The AssociationList of AssociatedMapColumns which can be of type:
      Column
      ColumnRange
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedMapColumn

      Column getAssociatedMapColumn() throws RemoteException, MdException
      Gets the Column for AssociatedMapColumn
      Returns:
      The Column ( null if not set ) of AssociatedMapColumn which can be of type:
      Column
      ColumnRange
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedMapTables

      AssociationList getAssociatedMapTables() throws RemoteException, MdException
      Gets the Association list of AssociatedMapTables
      Returns:
      The AssociationList of AssociatedMapTables which can be of type:
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedMapTable

      RelationalTable getAssociatedMapTable() throws RemoteException, MdException
      Gets the RelationalTable for AssociatedMapTable
      Returns:
      The RelationalTable ( null if not set ) of AssociatedMapTable which can be of type:
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedMapColumns

      AssociationList getAssociatedMapColumns(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of AssociatedMapColumns
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociatedMapColumns which can be of type:
      Column
      ColumnRange
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedMapTables

      AssociationList getAssociatedMapTables(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of AssociatedMapTables
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociatedMapTables which can be of type:
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setLocationPath

      void setLocationPath(String inLocationPath) throws RemoteException
      Sets the LocationPath value and sets the state to MetadataState.LOCAL.
      Parameters:
      inLocationPath - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationPath

      void setLocationPath(String inLocationPath, int state) throws RemoteException
      Sets the LocationPath Metadata State.
      Parameters:
      inLocationPath - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationPathState

      void setLocationPathState(int state) throws RemoteException
      Sets the Metadata State of LocationPath.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationPathType

      void setLocationPathType(int inLocationPathType) throws RemoteException
      Sets the LocationPathType value and sets the state to MetadataState.LOCAL.
      Parameters:
      inLocationPathType - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationPathType

      void setLocationPathType(int inLocationPathType, int state) throws RemoteException
      Sets the LocationPathType Metadata State.
      Parameters:
      inLocationPathType - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationPathType

      void setLocationPathType(String inLocationPathType) throws RemoteException
      Sets the LocationPathType value and sets the state to MetadataState.LOCAL.
      Parameters:
      inLocationPathType - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationPathType

      void setLocationPathType(String inLocationPathType, int state) throws RemoteException
      Sets the LocationPathType value and Metadata State.
      Parameters:
      inLocationPathType - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationPathTypeState

      void setLocationPathTypeState(int state) throws RemoteException
      Sets the Metadata State of LocationPathType.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMajorVersion

      void setMajorVersion(int inMajorVersion) throws RemoteException
      Sets the MajorVersion value and sets the state to MetadataState.LOCAL.
      Parameters:
      inMajorVersion - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMajorVersion

      void setMajorVersion(int inMajorVersion, int state) throws RemoteException
      Sets the MajorVersion Metadata State.
      Parameters:
      inMajorVersion - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMajorVersion

      void setMajorVersion(String inMajorVersion) throws RemoteException
      Sets the MajorVersion value and sets the state to MetadataState.LOCAL.
      Parameters:
      inMajorVersion - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setMajorVersion

      void setMajorVersion(String inMajorVersion, int state) throws RemoteException
      Sets the MajorVersion value and Metadata State.
      Parameters:
      inMajorVersion - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMajorVersionState

      void setMajorVersionState(int state) throws RemoteException
      Sets the Metadata State of MajorVersion.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMinorVersion

      void setMinorVersion(int inMinorVersion) throws RemoteException
      Sets the MinorVersion value and sets the state to MetadataState.LOCAL.
      Parameters:
      inMinorVersion - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMinorVersion

      void setMinorVersion(int inMinorVersion, int state) throws RemoteException
      Sets the MinorVersion Metadata State.
      Parameters:
      inMinorVersion - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMinorVersion

      void setMinorVersion(String inMinorVersion) throws RemoteException
      Sets the MinorVersion value and sets the state to MetadataState.LOCAL.
      Parameters:
      inMinorVersion - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setMinorVersion

      void setMinorVersion(String inMinorVersion, int state) throws RemoteException
      Sets the MinorVersion value and Metadata State.
      Parameters:
      inMinorVersion - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMinorVersionState

      void setMinorVersionState(int state) throws RemoteException
      Sets the Metadata State of MinorVersion.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setProcessTag

      void setProcessTag(int inProcessTag) throws RemoteException
      Sets the ProcessTag value and sets the state to MetadataState.LOCAL.
      Parameters:
      inProcessTag - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setProcessTag

      void setProcessTag(int inProcessTag, int state) throws RemoteException
      Sets the ProcessTag Metadata State.
      Parameters:
      inProcessTag - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setProcessTag

      void setProcessTag(String inProcessTag) throws RemoteException
      Sets the ProcessTag value and sets the state to MetadataState.LOCAL.
      Parameters:
      inProcessTag - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setProcessTag

      void setProcessTag(String inProcessTag, int state) throws RemoteException
      Sets the ProcessTag value and Metadata State.
      Parameters:
      inProcessTag - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setProcessTagState

      void setProcessTagState(int state) throws RemoteException
      Sets the Metadata State of ProcessTag.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAxisName

      void setAxisName(String inAxisName) throws RemoteException
      Sets the AxisName value and sets the state to MetadataState.LOCAL.
      Parameters:
      inAxisName - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setAxisName

      void setAxisName(String inAxisName, int state) throws RemoteException
      Sets the AxisName Metadata State.
      Parameters:
      inAxisName - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAxisNameState

      void setAxisNameState(int state) throws RemoteException
      Sets the Metadata State of AxisName.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setNodeSetFunction

      void setNodeSetFunction(String inNodeSetFunction) throws RemoteException
      Sets the NodeSetFunction value and sets the state to MetadataState.LOCAL.
      Parameters:
      inNodeSetFunction - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setNodeSetFunction

      void setNodeSetFunction(String inNodeSetFunction, int state) throws RemoteException
      Sets the NodeSetFunction Metadata State.
      Parameters:
      inNodeSetFunction - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setNodeSetFunctionState

      void setNodeSetFunctionState(int state) throws RemoteException
      Sets the Metadata State of NodeSetFunction.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSyntaxMarker

      void setSyntaxMarker(String inSyntaxMarker) throws RemoteException
      Sets the SyntaxMarker value and sets the state to MetadataState.LOCAL.
      Parameters:
      inSyntaxMarker - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setSyntaxMarker

      void setSyntaxMarker(String inSyntaxMarker, int state) throws RemoteException
      Sets the SyntaxMarker Metadata State.
      Parameters:
      inSyntaxMarker - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSyntaxMarkerState

      void setSyntaxMarkerState(int state) throws RemoteException
      Sets the Metadata State of SyntaxMarker.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMapColumns

      void setAssociatedMapColumns(AssociationList list) throws RemoteException
      Sets the AssociatedMapColumns list to be list. Objects of which can be of type:
      Column
      ColumnRange
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMapColumns

      void setAssociatedMapColumns(AssociationList list, int state) throws RemoteException
      Sets the AssociatedMapColumns list to be list. Objects of which can be of type:
      Column
      ColumnRange
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMapColumn

      void setAssociatedMapColumn(Column inObject) throws RemoteException
      Sets the AssociatedMapColumns list 0th element to be inObject.
      Parameters:
      inObject - Column
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMapTables

      void setAssociatedMapTables(AssociationList list) throws RemoteException
      Sets the AssociatedMapTables list to be list. Objects of which can be of type:
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMapTables

      void setAssociatedMapTables(AssociationList list, int state) throws RemoteException
      Sets the AssociatedMapTables list to be list. Objects of which can be of type:
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMapTable

      void setAssociatedMapTable(RelationalTable inObject) throws RemoteException
      Sets the AssociatedMapTables list 0th element to be inObject.
      Parameters:
      inObject - RelationalTable
      Throws:
      RemoteException - If error communicating with remote object.