com.sas.metadata.remote
Interface QueryClause

All Superinterfaces:

CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, java.rmi.Remote, Root, SecondaryType

All Known Subinterfaces:

GroupByClause, HavingClause, OnClause, OrderByClause, RowSelector, WhereClause

public interface QueryClause
extends SecondaryType

This abstract type represents types that are used to define the transformations that are performed. These include types that subset, group and order data.

Attributes of QueryClause are:

Associations of QueryClause are:

• Columns
• SourceCode

Usage

To create an instance of this QueryClause, use the factory create methods.
Example: create a QueryClause with name "QueryClause_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();
 QueryClause myObject = (QueryClause) factory.createComplexMetadataObject(objectStore, "QueryClause_Object", MetadataObjects.QUERYCLAUSE, "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 Summary

static java.lang.String	ASSOCIATION_COLUMNS_NAME Constant used for the name of the Columns association.
static java.lang.String	ASSOCIATION_SOURCECODE_NAME Constant used for the name of the SourceCode association.

Fields inherited from interface com.sas.metadata.remote.Root

ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAME

Fields inherited from interface com.sas.metadata.remote.MdObjectBase

ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME

Method Summary

AssociationList	getColumns() Gets the AssociationList of Columns
AssociationList	getColumns(boolean fGoToServer) Gets the Associationlist of Columns
Text	getSourceCode() Gets the Text for SourceCode
AssociationList	getSourceCodes() Gets the AssociationList of SourceCodes
AssociationList	getSourceCodes(boolean fGoToServer) Gets the Associationlist of SourceCodes
void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are: Columns SourceCode
void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are:
void	setColumns(AssociationList list) Sets the Columns list to be list.
void	setColumns(AssociationList inObjects, int state) Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
void	setSourceCode(Text inObject) Sets the SourceCodes list 0th element to be inObject.
void	setSourceCodes(AssociationList list) Sets the SourceCodes list to be list.
void	setSourceCodes(AssociationList list, int state) Sets the SourceCodes list to be list.

Methods inherited from interface com.sas.metadata.remote.Root

getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariables

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML

closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil

addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIds

Methods inherited from interface com.sas.metadata.remote.MdObjectBase

addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setState

Field Detail

ASSOCIATION_COLUMNS_NAME

static final java.lang.String ASSOCIATION_COLUMNS_NAME

Constant used for the name of the Columns association.

Columns: The columns used in this clause.

See Also:

Constant Field Values

ASSOCIATION_SOURCECODE_NAME

static final java.lang.String ASSOCIATION_SOURCECODE_NAME

Constant used for the name of the SourceCode association.

SourceCode: The stored code for this query clause.

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.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:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

initializePredObjects

void initializePredObjects()
                           throws java.rmi.RemoteException

(S) Adds the Associated objects to the predObjects which are:
Columns
SourceCode

Specified by:

initializePredObjects in interface MdObjectBase

Specified by:

initializePredObjects in interface Root

Specified by:

initializePredObjects in interface SecondaryType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getColumns

AssociationList getColumns()
                           throws java.rmi.RemoteException,
                                  MdException

Gets the AssociationList of Columns

Returns:

Returns the AssociationList of Columns which can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getSourceCodes

AssociationList getSourceCodes()
                               throws java.rmi.RemoteException,
                                      MdException

Gets the AssociationList of SourceCodes

Returns:

Returns the AssociationList of SourceCodes which can be of type:
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException

getSourceCode

Text getSourceCode()
                   throws java.rmi.RemoteException,
                          MdException

Gets the Text for SourceCode

Returns:

The Text ( null if not set) of SourceCodewhich can be of type:
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getColumns

AssociationList getColumns(boolean fGoToServer)
                           throws java.rmi.RemoteException,
                                  MdException

Gets the Associationlist of Columns

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of Columns which can be of type:
Column
ColumnRange

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getSourceCodes

AssociationList getSourceCodes(boolean fGoToServer)
                               throws java.rmi.RemoteException,
                                      MdException

Gets the Associationlist of SourceCodes

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the AssociationList of SourceCodes which can be of type:
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

setColumns

void setColumns(AssociationList list)
                throws java.rmi.RemoteException

Sets the Columns list to be list. Objects of which can be of type:
Column
ColumnRange

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setColumns

void setColumns(AssociationList inObjects,
                int state)
                throws java.rmi.RemoteException

Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList

Parameters:

inObjects - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setSourceCodes

void setSourceCodes(AssociationList list)
                    throws java.rmi.RemoteException

Sets the SourceCodes list to be list. Object of which can be of type:
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setSourceCodes

void setSourceCodes(AssociationList list,
                    int state)
                    throws java.rmi.RemoteException

Sets the SourceCodes list to be list. Object of which can be of type:
Text
TextStore
SASCatalogEntry
File
ArchiveFile
ArchiveEntry
Document

Parameters:

list - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setSourceCode

void setSourceCode(Text inObject)
                   throws java.rmi.RemoteException

Sets the SourceCodes list 0th element to be inObject.

Parameters:

inObject - Text

Throws:

java.rmi.RemoteException - If error communicating with remote object.