Package com.sas.metadata.remote
Interface MdStore
- All Superinterfaces:
Remote
- All Known Subinterfaces:
MdObjectStore,MdServerStore
public interface MdStore
extends Remote
This describes the base store object for metadata
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe context of the ExternalIdentity objects associated to new objects created under change managementstatic final StringThe ImportType of ExternalIdentity objects associated to new objects created under change managementstatic final intstatic final int -
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildStore(MdStore inStore) Add a store as a child to this one.voidUsed to add an object to the list of listeners for changes in the Metadata MapvoidaddVetoableChangeListener(VetoableChangeListener l) Adds a listener to the listvoidchangeHashKey(String strOldId, String strNewId) Change the hash key associated with an object, and send events for the removal of the old object and addition of the new object to Map.voidcreateExternalIdentityObject(CMetadata owningObject) This creates an ExternalIdentity object connection to owningObject for change management.StringcreateRefreshXMLforStore(boolean includeLocallyChangedItems, boolean getFullObjectUpdate) Creates XML for all objects in store.booleandeleteObject(CMetadata inObject) Makes an object unavailable in the object store.voiddispose()Cleans up this objectStore and it's objects from it's parent.voidPrints out the contents of the Detail object Map.voidfireMdObjectsAdded(MdEvent e, List ids) Used to notify all the listeners in the listner list of modifications to the object.voidfireMdObjectsModified(MdEvent e, List items) Used to notify all the listeners in the listner list of modifications to the object.voidfireMdObjectsRemoved(MdEvent e, List ids) Used to notify all the listeners in the listner list of modifications to the object.voidflushUpdates(List<CMetadata> updatedItems) Flush updated objects to parent store.List<CMetadata> Gets a List of changed objects.Map<String, CMetadata> Returns the Detail Object MapReturns the factory used to create objects.booleanDeprecated.getObject(String strFQID) Return object associated with IDGets the parent store to this oneintGets the type of store this is, either aMdStore.MDSTORETYPE_SERVERSTOREor aMdStore.MDSTORETYPE_OBJECTSTOREbooleanReturns whether or not the store has been disposed.booleanTells whether or not to go to server for the metadata.StringmakeID(String shortID) Creates a new id for an object.voidremoveChildStore(MdStore inStore) Remove a store as a child of this one.voidUsed to remove an object from the list of listeners for changes in the Metadata MapvoidremoveVetoableChangeListener(VetoableChangeListener l) Removes a listener from the list of vetoable listnersvoidresetStates(List<CMetadata> items) Resets all the objects in items to to set from server state or unSET.restoreObject(String objectID) Restores an object to the Store so that it is available from the store.voidsetGoToServerForMetadata(boolean goToServer) Tells whether or not to go to server for the metadata.voidsetIsGotToServerForMetadata(boolean goToServer) Deprecated.setGoToServerForMetadata(boolean)should be used insteadvoidsetOwningStore(MdStore parent) Sets the parent store to this one.voidupdateChangeListObjectIDs(String OldReposID, String NewReposID) Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id.voidupdateChangeListObjectIDs(String OldReposID, String NewReposID, String targetReposID) Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id.voidupdateCreatedItemsList(List<String> items) remove the items that have been updated from the createdItems list.void
-
Field Details
-
MDSTORETYPE_SERVERSTORE
static final int MDSTORETYPE_SERVERSTORE- See Also:
-
MDSTORETYPE_OBJECTSTORE
static final int MDSTORETYPE_OBJECTSTORE- See Also:
-
ExternalIdenty_Context
static final String ExternalIdenty_ContextThe context of the ExternalIdentity objects associated to new objects created under change management- See Also:
-
ExternalIdenty_ImportType
static final String ExternalIdenty_ImportTypeThe ImportType of ExternalIdentity objects associated to new objects created under change management- See Also:
-
-
Method Details
-
getStoreType
int getStoreType() throws RemoteExceptionGets the type of store this is, either aMdStore.MDSTORETYPE_SERVERSTOREor aMdStore.MDSTORETYPE_OBJECTSTORE- Returns:
- store type as an int.
- Throws:
RemoteException
-
getObject
Return object associated with ID- Parameters:
strFQID- String The ID of the object to get from the Map- Returns:
- CMetadata The object, or null if object not in Map.
- Throws:
RemoteException
-
makeID
String makeID(String shortID) throws RemoteException Creates a new id for an object.- Parameters:
shortID- String- Throws:
RemoteException
-
dumpDetailHashMap
void dumpDetailHashMap() throws RemoteExceptionPrints out the contents of the Detail object Map.- Throws:
RemoteException
-
updatedMetadataAll
- Throws:
RemoteExceptionMdException
-
changeHashKey
void changeHashKey(String strOldId, String strNewId) throws RemoteException Change the hash key associated with an object, and send events for the removal of the old object and addition of the new object to Map.- Parameters:
strOldId- StringstrNewId- String- Throws:
RemoteException
-
setOwningStore
Sets the parent store to this one.- Parameters:
parent- MdStore- Throws:
RemoteException
-
getOwningStore
Gets the parent store to this one- Returns:
- MdStore This store's parent.
- Throws:
RemoteException
-
dispose
void dispose() throws RemoteExceptionCleans up this objectStore and it's objects from it's parent.- Throws:
RemoteException
-
deleteObject
Makes an object unavailable in the object store. Use restore to make the object available after a delete- Parameters:
inObject- CMetadata- Throws:
RemoteException
-
restoreObject
Restores an object to the Store so that it is available from the store.- Parameters:
objectID- String- Throws:
RemoteException
-
getChangedObjects
Gets a List of changed objects.- Throws:
RemoteException
-
flushUpdates
Flush updated objects to parent store.- Throws:
RemoteException
-
resetStates
Resets all the objects in items to to set from server state or unSET.- Parameters:
items- List (NOTE: CMetadata objects in items)- Throws:
RemoteException
-
addMdStoreListener
Used to add an object to the list of listeners for changes in the Metadata Map- Parameters:
l- MetadataListener- Throws:
RemoteException
-
removeMdStoreListener
Used to remove an object from the list of listeners for changes in the Metadata Map- Parameters:
l- MetadataListener- Throws:
RemoteException
-
fireMdObjectsModified
Used to notify all the listeners in the listner list of modifications to the object.- Parameters:
e- ChangeEvent Created like:new ChangeEvent(Object generator)items- Vector Is list of items FQID that have been added.- Throws:
RemoteException
-
fireMdObjectsAdded
Used to notify all the listeners in the listner list of modifications to the object.- Parameters:
e- ChangeEvent Created like:new ChangeEvent(Object generator)items- Vector Is list of items FQID that have been added.- Throws:
RemoteException
-
fireMdObjectsRemoved
Used to notify all the listeners in the listner list of modifications to the object.- Parameters:
e- ChangeEvent Created like:new ChangeEvent(Object generator)items- Vector Is list of items FQID that have been added.- Throws:
RemoteException
-
getDetailObjectMap
Returns the Detail Object Map- Returns:
- The association Map
- Throws:
RemoteException
-
getFactory
Returns the factory used to create objects.- Returns:
- MdFactory
- Throws:
RemoteException
-
getIsGoToServerForMetadata
boolean getIsGoToServerForMetadata() throws RemoteExceptionDeprecated.isGoToServerForMetadata()should be used insteadTells whether or not to go to server for the metadata.- Returns:
- boolean true if allowed to go to the server.
- Throws:
RemoteException
-
setIsGotToServerForMetadata
void setIsGotToServerForMetadata(boolean goToServer) throws RemoteException Deprecated.setGoToServerForMetadata(boolean)should be used insteadTells whether or not to go to server for the metadata.- Parameters:
goToServer- go for metadata- Throws:
RemoteException
-
setGoToServerForMetadata
void setGoToServerForMetadata(boolean goToServer) throws RemoteException Tells whether or not to go to server for the metadata.- Parameters:
goToServer- go for metadata- Throws:
RemoteException
-
isGoToServerForMetadata
boolean isGoToServerForMetadata() throws RemoteExceptionTells whether or not to go to server for the metadata.- Returns:
- true if allowed to go to the server.
- Throws:
RemoteException
-
isDisposed
boolean isDisposed() throws RemoteExceptionReturns whether or not the store has been disposed.- Returns:
- boolean
- Throws:
RemoteException
-
addVetoableChangeListener
void addVetoableChangeListener(VetoableChangeListener l) throws RemoteException Adds a listener to the list- Parameters:
l- VetoableChangeListener- Throws:
RemoteException
-
removeVetoableChangeListener
void removeVetoableChangeListener(VetoableChangeListener l) throws RemoteException Removes a listener from the list of vetoable listners- Parameters:
l- VetoableChangeListener- Throws:
RemoteException
-
createExternalIdentityObject
This creates an ExternalIdentity object connection to owningObject for change management. This new object contains the real repos id for the new object.- Parameters:
owningObject- CMetadata Object to which to attach ExternalIdentity.- Throws:
RemoteException
-
updateChangeListObjectIDs
void updateChangeListObjectIDs(String OldReposID, String NewReposID) throws RemoteException Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id. This should be only the short ID. "AAAAAAAA" to "A5KE2N5K"- Parameters:
OldReposID- String The repos of objects when they were created.NewReposID- String The project repos id if under change management, the target if not.- Throws:
RemoteException
-
updateChangeListObjectIDs
void updateChangeListObjectIDs(String OldReposID, String NewReposID, String targetReposID) throws RemoteException Changes a new objects repos id for all the objects in the change list of this object store, to a specified repos id. This should be only the short ID. "AAAAAAAA" to "A5KE2N5K"- Parameters:
OldReposID- String The repos of objects when they were created.NewReposID- String The project repos id if under change management, the target if not.targetReposID- String In change management is the real repos the objects will be checked into- Throws:
RemoteException
-
updateCreatedItemsList
void updateCreatedItemsList(List<String> items) throws RemoteException remove the items that have been updated from the createdItems list.- Parameters:
items-- Throws:
RemoteException
-
addChildStore
Add a store as a child to this one.- Parameters:
inStore-- Throws:
RemoteException
-
removeChildStore
Remove a store as a child of this one.- Parameters:
inStore-- Throws:
RemoteException
-
createRefreshXMLforStore
String createRefreshXMLforStore(boolean includeLocallyChangedItems, boolean getFullObjectUpdate) throws RemoteException Creates XML for all objects in store.- Returns:
- XML string for objects in store
- Throws:
RemoteException
-
isGoToServerForMetadata()should be used instead