|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Index
Represents an index on a physical structure. It is tied to the columns that make up the index.
Attributes of Index are:
Associations of Index 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(); Index myObject = (Index) factory.createComplexMetadataObject(objectStore, "Index_Object", MetadataObjects.INDEX, "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_COLUMNS_NAME
Constant used for the name of the Columns association. |
static java.lang.String |
ASSOCIATION_OWNINGPHYSICALTABLE_NAME
Constant used for the name of the OwningPhysicalTable association. |
static java.lang.String |
ATTRIBUTE_INDEXNAME_NAME
Constant used for the name of the IndexName attribute. |
static java.lang.String |
ATTRIBUTE_ISCLUSTERED_NAME
Constant used for the name of the IsClustered attribute. |
static java.lang.String |
ATTRIBUTE_ISNOMISS_NAME
Constant used for the name of the IsNoMiss attribute. |
static java.lang.String |
ATTRIBUTE_ISUNIQUE_NAME
Constant used for the name of the IsUnique attribute. |
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 | |
---|---|
AssociationList |
getColumns()
Gets the AssociationList of Columns |
AssociationList |
getColumns(boolean fGoToServer)
Gets the Associationlist of Columns |
java.lang.String |
getIndexName()
Gets the String value of IndexName |
int |
getIndexNameMaxLength()
Gets the maximum length of IndexName |
int |
getIndexNameState()
Gets the Metadata State of IndexName |
int |
getIsClustered()
Gets the int value of IsClustered |
int |
getIsClusteredState()
Gets the Metadata State of IsClustered |
int |
getIsNoMiss()
Gets the int value of IsNoMiss |
int |
getIsNoMissState()
Gets the Metadata State of IsNoMiss |
int |
getIsUnique()
Gets the int value of IsUnique |
int |
getIsUniqueState()
Gets the Metadata State of IsUnique |
PhysicalTable |
getOwningPhysicalTable()
Gets the PhysicalTable for OwningPhysicalTable |
AssociationList |
getOwningPhysicalTables()
Gets the Association list of OwningPhysicalTables |
AssociationList |
getOwningPhysicalTables(boolean fGoToServer)
Gets the Associationlist of OwningPhysicalTables |
void |
initializePredObjects()
(S) Adds the Associated objects to the predObjects which are: Columns |
void |
initializeRequiredObjects()
(S) This initializes the Required Objects(Roles) which are: OwningPhysicalTable |
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 |
setIndexName(java.lang.String inIndexName)
Sets the IndexName value and sets the state to MetadataState.LOCAL. |
void |
setIndexName(java.lang.String inIndexName,
int state)
Sets the IndexName Metadata State. |
void |
setIndexNameState(int state)
Sets the Metadata State of IndexName . |
void |
setIsClustered(int inIsClustered)
Sets the IsClustered value and sets the state to MetadataState.LOCAL. |
void |
setIsClustered(int inIsClustered,
int state)
Sets the IsClustered Metadata State. |
void |
setIsClustered(java.lang.String inIsClustered)
Sets the IsClustered value and sets the state to MetadataState.LOCAL. |
void |
setIsClustered(java.lang.String inIsClustered,
int state)
Sets the IsClustered value and Metadata State. |
void |
setIsClusteredState(int state)
Sets the Metadata State of IsClustered . |
void |
setIsNoMiss(int inIsNoMiss)
Sets the IsNoMiss value and sets the state to MetadataState.LOCAL. |
void |
setIsNoMiss(int inIsNoMiss,
int state)
Sets the IsNoMiss Metadata State. |
void |
setIsNoMiss(java.lang.String inIsNoMiss)
Sets the IsNoMiss value and sets the state to MetadataState.LOCAL. |
void |
setIsNoMiss(java.lang.String inIsNoMiss,
int state)
Sets the IsNoMiss value and Metadata State. |
void |
setIsNoMissState(int state)
Sets the Metadata State of IsNoMiss . |
void |
setIsUnique(int inIsUnique)
Sets the IsUnique value and sets the state to MetadataState.LOCAL. |
void |
setIsUnique(int inIsUnique,
int state)
Sets the IsUnique Metadata State. |
void |
setIsUnique(java.lang.String inIsUnique)
Sets the IsUnique value and sets the state to MetadataState.LOCAL. |
void |
setIsUnique(java.lang.String inIsUnique,
int state)
Sets the IsUnique value and Metadata State. |
void |
setIsUniqueState(int state)
Sets the Metadata State of IsUnique . |
void |
setOwningPhysicalTable(PhysicalTable inObject)
Sets the OwningPhysicalTables list 0th element to be inObject . |
void |
setOwningPhysicalTables(AssociationList list)
Sets the OwningPhysicalTables list to be list . |
void |
setOwningPhysicalTables(AssociationList list,
int state)
Sets the OwningPhysicalTables list to be list . |
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_ISCLUSTERED_NAME
IsClustered: This attribute indicates that this index supports clustering.
static final java.lang.String ATTRIBUTE_ISUNIQUE_NAME
IsUnique: This attribute indicates whether this index is a unique index or not.
static final java.lang.String ATTRIBUTE_INDEXNAME_NAME
IndexName: The name of the index.
static final java.lang.String ATTRIBUTE_ISNOMISS_NAME
IsNoMiss: If true, then missing values are not maintained by the index
static final java.lang.String ASSOCIATION_COLUMNS_NAME
Columns: The list of columns that are indexed by this index.
static final java.lang.String ASSOCIATION_OWNINGPHYSICALTABLE_NAME
OwningPhysicalTable: The table that is indexed by this object.
Method Detail |
---|
void initializeRequiredObjects() throws java.rmi.RemoteException
OwningPhysicalTable
initializeRequiredObjects
in interface MdObjectBaseUtil
initializeRequiredObjects
in interface PrimaryType
initializeRequiredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.void initializePredObjects() throws java.rmi.RemoteException
Columns
initializePredObjects
in interface MdObjectBase
initializePredObjects
in interface PrimaryType
initializePredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsClustered() throws java.rmi.RemoteException
int
value of IsClustered
IsClustered
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsClusteredState() throws java.rmi.RemoteException
IsClustered
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsUnique() throws java.rmi.RemoteException
int
value of IsUnique
IsUnique
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsUniqueState() throws java.rmi.RemoteException
IsUnique
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getIndexName() throws java.rmi.RemoteException
String
value of IndexName
IndexName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIndexNameState() throws java.rmi.RemoteException
IndexName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIndexNameMaxLength() throws java.rmi.RemoteException
IndexName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsNoMiss() throws java.rmi.RemoteException
int
value of IsNoMiss
IsNoMiss
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getIsNoMissState() throws java.rmi.RemoteException
IsNoMiss
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.AssociationList getColumns() throws java.rmi.RemoteException, MdException
Columns
Columns
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 getOwningPhysicalTables() throws java.rmi.RemoteException, MdException
OwningPhysicalTables
OwningPhysicalTables
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.PhysicalTable getOwningPhysicalTable() throws java.rmi.RemoteException, MdException
PhysicalTable
for OwningPhysicalTable
PhysicalTable
( null
if not set ) of OwningPhysicalTable
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 getColumns(boolean fGoToServer) throws java.rmi.RemoteException, MdException
Columns
fGoToServer
- boolean Get the value from the server.
Columns
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 getOwningPhysicalTables(boolean fGoToServer) throws java.rmi.RemoteException, MdException
OwningPhysicalTables
fGoToServer
- boolean Get the value from the server.
OwningPhysicalTables
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 setIsClustered(int inIsClustered) throws java.rmi.RemoteException
IsClustered
value and sets the state to MetadataState.LOCAL.
inIsClustered
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsClustered(int inIsClustered, int state) throws java.rmi.RemoteException
IsClustered
Metadata State.
inIsClustered
- intstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsClustered(java.lang.String inIsClustered) throws java.rmi.RemoteException
IsClustered
value and sets the state to MetadataState.LOCAL.
inIsClustered
- String
java.rmi.RemoteException
- If error communicating with remote object.void setIsClustered(java.lang.String inIsClustered, int state) throws java.rmi.RemoteException
IsClustered
value and Metadata State.
inIsClustered
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsClusteredState(int state) throws java.rmi.RemoteException
IsClustered
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsUnique(int inIsUnique) throws java.rmi.RemoteException
IsUnique
value and sets the state to MetadataState.LOCAL.
inIsUnique
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsUnique(int inIsUnique, int state) throws java.rmi.RemoteException
IsUnique
Metadata State.
inIsUnique
- intstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsUnique(java.lang.String inIsUnique) throws java.rmi.RemoteException
IsUnique
value and sets the state to MetadataState.LOCAL.
inIsUnique
- String
java.rmi.RemoteException
- If error communicating with remote object.void setIsUnique(java.lang.String inIsUnique, int state) throws java.rmi.RemoteException
IsUnique
value and Metadata State.
inIsUnique
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsUniqueState(int state) throws java.rmi.RemoteException
IsUnique
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIndexName(java.lang.String inIndexName) throws java.rmi.RemoteException
IndexName
value and sets the state to MetadataState.LOCAL.
inIndexName
- String
java.rmi.RemoteException
- If error communicating with remote object.void setIndexName(java.lang.String inIndexName, int state) throws java.rmi.RemoteException
IndexName
Metadata State.
inIndexName
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIndexNameState(int state) throws java.rmi.RemoteException
IndexName
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsNoMiss(int inIsNoMiss) throws java.rmi.RemoteException
IsNoMiss
value and sets the state to MetadataState.LOCAL.
inIsNoMiss
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsNoMiss(int inIsNoMiss, int state) throws java.rmi.RemoteException
IsNoMiss
Metadata State.
inIsNoMiss
- intstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsNoMiss(java.lang.String inIsNoMiss) throws java.rmi.RemoteException
IsNoMiss
value and sets the state to MetadataState.LOCAL.
inIsNoMiss
- String
java.rmi.RemoteException
- If error communicating with remote object.void setIsNoMiss(java.lang.String inIsNoMiss, int state) throws java.rmi.RemoteException
IsNoMiss
value and Metadata State.
inIsNoMiss
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setIsNoMissState(int state) throws java.rmi.RemoteException
IsNoMiss
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setColumns(AssociationList list) throws java.rmi.RemoteException
Columns
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setColumns(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setOwningPhysicalTables(AssociationList list) throws java.rmi.RemoteException
OwningPhysicalTables
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setOwningPhysicalTables(AssociationList list, int state) throws java.rmi.RemoteException
OwningPhysicalTables
list to be list
. Objects of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setOwningPhysicalTable(PhysicalTable inObject) throws java.rmi.RemoteException
OwningPhysicalTables
list 0th element to be inObject
.
inObject
- PhysicalTable
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 |