|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SASLibrary
Represents a SAS library. A SAS library is a collection of one or more SAS files that are recognized by SAS software and that are referenced and stored as a unit. Each file is a member of the library. SAS libraries are accessed with a LIBNAME statement. The LIBNAME statement specifies the data engine and any required or optional parameters for accessing the data source. The SASLibrary metadata type stores the LIBNAME statement arguments necessary to access a particular data source in a metadata repository.
Attributes of SASLibrary are:
Associations of SASLibrary are:
factory
create methods. // 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(); SASLibrary myObject = (SASLibrary) factory.createComplexMetadataObject(objectStore, "SASLibrary_Object", MetadataObjects.SASLIBRARY, "AAAAAAAA"); myObject.updateMetadataAll(); // Write object to server objectStore.dispose(); // dispose of the object store if it is no longer needed
MdOMIUtil
.
updateMetadataAll
method.
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.
Field Summary | |
---|---|
static java.lang.String |
ASSOCIATION_DEFAULTLOGIN_NAME
Constant used for the name of the DefaultLogin association. |
static java.lang.String |
ASSOCIATION_LIBRARYCONNECTION_NAME
Constant used for the name of the LibraryConnection association. |
static java.lang.String |
ASSOCIATION_SASCATALOGS_NAME
Constant used for the name of the SASCatalogs association. |
static java.lang.String |
ATTRIBUTE_ENGINE_NAME
Constant used for the name of the Engine attribute. |
static java.lang.String |
ATTRIBUTE_ISDBMSLIBNAME_NAME
Constant used for the name of the IsDBMSLibname attribute. |
static java.lang.String |
ATTRIBUTE_ISPREASSIGNED_NAME
Constant used for the name of the IsPreassigned attribute. |
static java.lang.String |
ATTRIBUTE_LIBREF_NAME
Constant used for the name of the Libref attribute. |
Fields inherited from interface com.sas.metadata.remote.RelationalSchema |
---|
ASSOCIATION_SCHEMAPACKAGE_NAME, ASSOCIATION_TABLES_NAME |
Fields inherited from interface com.sas.metadata.remote.DeployedDataPackage |
---|
ASSOCIATION_ALIASES_NAME, ASSOCIATION_ALIASFOR_NAME, ASSOCIATION_DEPLOYEDCOMPONENTS_NAME, ASSOCIATION_TABLECOLLECTIONS_NAME, ASSOCIATION_USEDBYPACKAGES_NAME, ASSOCIATION_USINGPACKAGES_NAME |
Fields inherited from interface com.sas.metadata.remote.PrimaryType |
---|
ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_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 | |
---|---|
Login |
getDefaultLogin()
Gets the Login for DefaultLogin |
AssociationList |
getDefaultLogins()
Gets the AssociationList of DefaultLogins |
AssociationList |
getDefaultLogins(boolean fGoToServer)
Gets the Associationlist of DefaultLogins |
java.lang.String |
getEngine()
Gets the String value of Engine |
int |
getEngineMaxLength()
Gets the maximum length of Engine |
int |
getEngineState()
Gets the Metadata State of Engine |
int |
getIsDBMSLibname()
Gets the int value of IsDBMSLibname |
int |
getIsDBMSLibnameState()
Gets the Metadata State of IsDBMSLibname |
int |
getIsPreassigned()
Gets the int value of IsPreassigned |
int |
getIsPreassignedState()
Gets the Metadata State of IsPreassigned |
SASClientConnection |
getLibraryConnection()
Gets the SASClientConnection for LibraryConnection |
AssociationList |
getLibraryConnections()
Gets the AssociationList of LibraryConnections |
AssociationList |
getLibraryConnections(boolean fGoToServer)
Gets the Associationlist of LibraryConnections |
java.lang.String |
getLibref()
Gets the String value of Libref |
int |
getLibrefMaxLength()
Gets the maximum length of Libref |
int |
getLibrefState()
Gets the Metadata State of Libref |
AssociationList |
getSASCatalogs()
Gets the AssociationList of SASCatalogs |
AssociationList |
getSASCatalogs(boolean fGoToServer)
Gets the Associationlist of SASCatalogs |
void |
initializePredObjects()
(S) Adds the Associated objects to the predObjects which are: DefaultLogin LibraryConnection SASCatalogs |
void |
initializeRequiredObjects()
(S) This initializes the Required Objects(Roles) which are: |
void |
setDefaultLogin(Login inObject)
Sets the DefaultLogins list 0th element to be inObject . |
void |
setDefaultLogins(AssociationList list)
Sets the DefaultLogins list to be list . |
void |
setDefaultLogins(AssociationList list,
int state)
Sets the DefaultLogins list to be list . |
void |
setEngine(java.lang.String inEngine)
Sets the Engine value and sets the state to MetadataState.LOCAL. |
void |
setEngine(java.lang.String inEngine,
int state)
Sets the Engine Metadata State. |
void |
setEngineState(int state)
Sets the Metadata State of Engine . |
void |
setIsDBMSLibname(int inIsDBMSLibname)
Sets the IsDBMSLibname value and sets the state to MetadataState.LOCAL. |
void |
setIsDBMSLibname(int inIsDBMSLibname,
int state)
Sets the IsDBMSLibname Metadata State. |
void |
setIsDBMSLibname(java.lang.String inIsDBMSLibname)
Sets the IsDBMSLibname value and sets the state to MetadataState.LOCAL. |
void |
setIsDBMSLibname(java.lang.String inIsDBMSLibname,
int state)
Sets the IsDBMSLibname value and Metadata State. |
void |
setIsDBMSLibnameState(int state)
Sets the Metadata State of IsDBMSLibname . |
void |
setIsPreassigned(int inIsPreassigned)
Sets the IsPreassigned value and sets the state to MetadataState.LOCAL. |
void |
setIsPreassigned(int inIsPreassigned,
int state)
Sets the IsPreassigned Metadata State. |
void |
setIsPreassigned(java.lang.String inIsPreassigned)
Sets the IsPreassigned value and sets the state to MetadataState.LOCAL. |
void |
setIsPreassigned(java.lang.String inIsPreassigned,
int state)
Sets the IsPreassigned value and Metadata State. |
void |
setIsPreassignedState(int state)
Sets the Metadata State of IsPreassigned . |
void |
setLibraryConnection(SASClientConnection inObject)
Sets the LibraryConnections list 0th element to be inObject . |
void |
setLibraryConnections(AssociationList list)
Sets the LibraryConnections list to be list . |
void |
setLibraryConnections(AssociationList list,
int state)
Sets the LibraryConnections list to be list . |
void |
setLibref(java.lang.String inLibref)
Sets the Libref value and sets the state to MetadataState.LOCAL. |
void |
setLibref(java.lang.String inLibref,
int state)
Sets the Libref Metadata State. |
void |
setLibrefState(int state)
Sets the Metadata State of Libref . |
void |
setSASCatalogs(AssociationList list)
Sets the SASCatalogs list to be list . |
void |
setSASCatalogs(AssociationList inObjects,
int state)
Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList |
Methods inherited from interface com.sas.metadata.remote.RelationalSchema |
---|
getSchemaPackage, getSchemaPackages, getSchemaPackages, getTables, getTables, setSchemaPackage, setSchemaPackages, setSchemaPackages, setTables, setTables |
Methods inherited from interface com.sas.metadata.remote.DeployedDataPackage |
---|
getAliases, getAliases, getAliasFor, getAliasFors, getAliasFors, getDeployedComponents, getDeployedComponents, getTableCollections, getTableCollections, getUsedByPackages, getUsedByPackages, getUsingPackages, getUsingPackages, setAliases, setAliases, setAliasFor, setAliasFors, setAliasFors, setDeployedComponents, setDeployedComponents, setTableCollections, setTableCollections, setUsedByPackages, setUsedByPackages, setUsingPackages, setUsingPackages |
Methods inherited from interface com.sas.metadata.remote.PrimaryType |
---|
getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState |
Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML |
---|
closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll |
Field Detail |
---|
static final java.lang.String ATTRIBUTE_ISDBMSLIBNAME_NAME
IsDBMSLibname: A boolean that indicates whether this library uses a connection to an external database server.
static final java.lang.String ATTRIBUTE_ENGINE_NAME
Engine: The engine specification used by the SAS LIBNAME statement.
static final java.lang.String ATTRIBUTE_LIBREF_NAME
Libref: The libref used by the SAS LIBNAME statement.
static final java.lang.String ATTRIBUTE_ISPREASSIGNED_NAME
IsPreassigned: This boolean indicates whether the library is pre-assigned in the SAS session. If true, the other attributes of this object that contain information used by a LIBNAME statement may be provided for documentation purposes only but is not required to access the library, because the LIBNAME has been assigned via some other mechanism.
static final java.lang.String ASSOCIATION_DEFAULTLOGIN_NAME
DefaultLogin: The default login to use for this library.
static final java.lang.String ASSOCIATION_LIBRARYCONNECTION_NAME
LibraryConnection: The connection to a DBMS server or a SAS server.
static final java.lang.String ASSOCIATION_SASCATALOGS_NAME
SASCatalogs: The catalogs contained in this library.
Method Detail |
---|
void initializeRequiredObjects() throws java.rmi.RemoteException
initializeRequiredObjects
in interface DeployedDataPackage
initializeRequiredObjects
in interface MdObjectBaseUtil
initializeRequiredObjects
in interface PrimaryType
initializeRequiredObjects
in interface RelationalSchema
initializeRequiredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.void initializePredObjects() throws java.rmi.RemoteException
DefaultLogin
LibraryConnection
SASCatalogs
initializePredObjects
in interface DeployedDataPackage
initializePredObjects
in interface MdObjectBase
initializePredObjects
in interface PrimaryType
initializePredObjects
in interface RelationalSchema
initializePredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsDBMSLibname() throws java.rmi.RemoteException
int
value of IsDBMSLibname
IsDBMSLibname
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsDBMSLibnameState() throws java.rmi.RemoteException
IsDBMSLibname
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getEngine() throws java.rmi.RemoteException
String
value of Engine
Engine
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getEngineState() throws java.rmi.RemoteException
Engine
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getEngineMaxLength() throws java.rmi.RemoteException
Engine
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getLibref() throws java.rmi.RemoteException
String
value of Libref
Libref
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getLibrefState() throws java.rmi.RemoteException
Libref
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getLibrefMaxLength() throws java.rmi.RemoteException
Libref
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsPreassigned() throws java.rmi.RemoteException
int
value of IsPreassigned
IsPreassigned
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsPreassignedState() throws java.rmi.RemoteException
IsPreassigned
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.AssociationList getDefaultLogins() throws java.rmi.RemoteException, MdException
DefaultLogins
DefaultLogins
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
Login getDefaultLogin() throws java.rmi.RemoteException, MdException
Login
for DefaultLogin
Login
( null
if not set) of DefaultLogin
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getLibraryConnections() throws java.rmi.RemoteException, MdException
LibraryConnections
LibraryConnections
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
SASClientConnection getLibraryConnection() throws java.rmi.RemoteException, MdException
SASClientConnection
for LibraryConnection
SASClientConnection
( null
if not set) of LibraryConnection
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getSASCatalogs() throws java.rmi.RemoteException, MdException
SASCatalogs
SASCatalogs
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getDefaultLogins(boolean fGoToServer) throws java.rmi.RemoteException, MdException
DefaultLogins
fGoToServer
- boolean Get the value from the server.
DefaultLogins
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getLibraryConnections(boolean fGoToServer) throws java.rmi.RemoteException, MdException
LibraryConnections
fGoToServer
- boolean Get the value from the server.
LibraryConnections
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getSASCatalogs(boolean fGoToServer) throws java.rmi.RemoteException, MdException
SASCatalogs
fGoToServer
- boolean Get the value from the server.
SASCatalogs
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.void setIsDBMSLibname(int inIsDBMSLibname) throws java.rmi.RemoteException
IsDBMSLibname
value and sets the state to MetadataState.LOCAL.
inIsDBMSLibname
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsDBMSLibname(int inIsDBMSLibname, int state) throws java.rmi.RemoteException
IsDBMSLibname
Metadata State.
inIsDBMSLibname
- intstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsDBMSLibname(java.lang.String inIsDBMSLibname) throws java.rmi.RemoteException
IsDBMSLibname
value and sets the state to MetadataState.LOCAL.
inIsDBMSLibname
- String
java.rmi.RemoteException
- If error communicating with remote object.void setIsDBMSLibname(java.lang.String inIsDBMSLibname, int state) throws java.rmi.RemoteException
IsDBMSLibname
value and Metadata State.
inIsDBMSLibname
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsDBMSLibnameState(int state) throws java.rmi.RemoteException
IsDBMSLibname
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setEngine(java.lang.String inEngine) throws java.rmi.RemoteException
Engine
value and sets the state to MetadataState.LOCAL.
inEngine
- String
java.rmi.RemoteException
- If error communicating with remote object.void setEngine(java.lang.String inEngine, int state) throws java.rmi.RemoteException
Engine
Metadata State.
inEngine
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setEngineState(int state) throws java.rmi.RemoteException
Engine
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setLibref(java.lang.String inLibref) throws java.rmi.RemoteException
Libref
value and sets the state to MetadataState.LOCAL.
inLibref
- String
java.rmi.RemoteException
- If error communicating with remote object.void setLibref(java.lang.String inLibref, int state) throws java.rmi.RemoteException
Libref
Metadata State.
inLibref
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setLibrefState(int state) throws java.rmi.RemoteException
Libref
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsPreassigned(int inIsPreassigned) throws java.rmi.RemoteException
IsPreassigned
value and sets the state to MetadataState.LOCAL.
inIsPreassigned
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsPreassigned(int inIsPreassigned, int state) throws java.rmi.RemoteException
IsPreassigned
Metadata State.
inIsPreassigned
- intstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsPreassigned(java.lang.String inIsPreassigned) throws java.rmi.RemoteException
IsPreassigned
value and sets the state to MetadataState.LOCAL.
inIsPreassigned
- String
java.rmi.RemoteException
- If error communicating with remote object.void setIsPreassigned(java.lang.String inIsPreassigned, int state) throws java.rmi.RemoteException
IsPreassigned
value and Metadata State.
inIsPreassigned
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsPreassignedState(int state) throws java.rmi.RemoteException
IsPreassigned
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setDefaultLogins(AssociationList list) throws java.rmi.RemoteException
DefaultLogins
list to be list
. Object of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setDefaultLogins(AssociationList list, int state) throws java.rmi.RemoteException
DefaultLogins
list to be list
. Object of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setDefaultLogin(Login inObject) throws java.rmi.RemoteException
DefaultLogins
list 0th element to be inObject
.
inObject
- Login
java.rmi.RemoteException
- If error communicating with remote object.void setLibraryConnections(AssociationList list) throws java.rmi.RemoteException
LibraryConnections
list to be list
. Object of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setLibraryConnections(AssociationList list, int state) throws java.rmi.RemoteException
LibraryConnections
list to be list
. Object of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setLibraryConnection(SASClientConnection inObject) throws java.rmi.RemoteException
LibraryConnections
list 0th element to be inObject
.
inObject
- SASClientConnection
java.rmi.RemoteException
- If error communicating with remote object.void setSASCatalogs(AssociationList list) throws java.rmi.RemoteException
SASCatalogs
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setSASCatalogs(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.
|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |