|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Cube
Central metadata object for representation of multidimensional data.
A Cube belongs to a Schema
, and is described by a list of
Dimension
s and a list of Measure
s. It may also have one or
more NamedSet
s.
getMeasures()
Method Summary | |
---|---|
NamedList<Dimension> |
getDimensions()
Returns a list of Dimension objects in this Cube. |
NamedList<Hierarchy> |
getHierarchies()
Returns a list of Hierarchy objects in this Cube. |
java.util.List<Measure> |
getMeasures()
Returns a list of Measure objects in this Cube. |
Schema |
getSchema()
Returns the Schema this Cube belongs to. |
NamedList<NamedSet> |
getSets()
Returns a list of NamedSet objects in this Cube. |
java.util.Collection<java.util.Locale> |
getSupportedLocales()
Returns a collection of Locale objects for which this
Cube has been localized. |
Member |
lookupMember(java.lang.String... nameParts)
Finds a member in the current Cube based upon its fully-qualified name. |
java.util.List<Member> |
lookupMembers(java.util.Set<Member.TreeOp> treeOps,
java.lang.String... nameParts)
Finds a collection of members in the current Cube related to a given member. |
Methods inherited from interface org.olap4j.metadata.MetadataElement |
---|
getCaption, getDescription, getName, getUniqueName |
Method Detail |
---|
Schema getSchema()
Schema
this Cube belongs to.
NamedList<Dimension> getDimensions()
Dimension
objects in this Cube.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
OlapDatabaseMetaData.getDimensions(String,String,String,String)
NamedList<Hierarchy> getHierarchies()
Hierarchy
objects in this Cube.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
OlapDatabaseMetaData.getHierarchies(String, String, String, String, String)
java.util.List<Measure> getMeasures()
Measure
objects in this Cube.
The list includes both stored and calculated members, and (unlike
the OlapDatabaseMetaData.getMeasures(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
method or the
MDSCHEMA_MEASURES XMLA request) is sorted by ordinal.
OlapDatabaseMetaData.getMeasures(String,String,String,String,String)
NamedList<NamedSet> getSets()
NamedSet
objects in this Cube.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
OlapDatabaseMetaData.getSets(String,String,String,String)
java.util.Collection<java.util.Locale> getSupportedLocales()
Locale
objects for which this
Cube
has been localized.
Consider the following use case. Suppose one cube is available in English and French, and in French and Spanish, and both are shown in same portal. Clients typically say that seeing reports in a mixture of languages is confusing; the portal would figure out the best common language, in this case French. This method allows the client to choose the most appropriate locale.
The list is advisory: a client is free to choose another locale, in which case, the server will probably revert to the base locale for locale-specific behavior such as captions and formatting.
Cube
has been
localizedSchema.getSupportedLocales()
Member lookupMember(java.lang.String... nameParts) throws OlapException
The fully-qualified name starts with the name of the dimension, followed by the name of a root member, and continues with the name of each successive member on the path from the root member. If a member's name is unique within its level, preceding member name can be omitted.
For example,
lookupMember("Product", "Food")
and
lookupMember("Product", "All Products", "Food")
are both valid ways to locate the "Food" member of the "Product"
dimension.
nameParts
- Components of the fully-qualified member name
OlapException
- if error occursjava.util.List<Member> lookupMembers(java.util.Set<Member.TreeOp> treeOps, java.lang.String... nameParts) throws OlapException
The method first looks up a member with the given fully-qualified
name as for lookupMember(String[])
, then applies the set of
tree-operations to find related members.
The returned collection is sorted by level number then by member ordinal. If no member is found with the given name, the collection is empty.
For example,
returnslookupMembers( EnumSet.of(TreeOp.ANCESTORS, TreeOp.CHILDREN), "Time", "1997", "Q2")
[Time].[1997] [Time].[1997].[Q2].[4] [Time].[1997].[Q2].[5] [Time].[1997].[Q2].[6]
The fully-qualified name starts with the name of the dimension, followed by the name of a root member, and continues with the name of each successive member on the path from the root member. If a member's name is unique within its level, preceding member name can be omitted.
For example,
lookupMember("Product", "Food")
and
lookupMember("Product", "All Products", "Food")
are both valid ways to locate the "Food" member of the "Product"
dimension.
nameParts
- Components of the fully-qualified member nametreeOps
- Collection of tree operations to travel relative to
given member in order to create list of members
OlapException
- if error occurs
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |