|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.subsets.impl.SubsetHandlerImpl
public class SubsetHandlerImpl
SubsetHandlerImpl
- API INTERNAL CLASS -
Constructor Summary | |
---|---|
SubsetHandlerImpl(Dimension dimension)
Deprecated. use hierarchy constructor instead. |
Method Summary | |
---|---|
Subset2 |
addSubset(java.lang.String name,
int type)
Adds a new Subset2 with the given name and type to this hierarchy |
boolean |
canRead(int type)
Checks if the user is allowed to read subsets of given type |
boolean |
canWrite(int type)
Checks if the user is allowed to write subsets of given type |
Subset2 |
create(java.lang.String id,
java.lang.String name,
Hierarchy hierarchy,
int type)
- API INTERNAL - |
Dimension |
getDimension()
Returns the Dimension to which this
SubsetHandler is registered. |
Hierarchy |
getHierarchy()
Returns the Hierarchy to which this
SubsetHandler is registered. |
Subset2 |
getSubset(java.lang.String id,
int type)
Returns the Subset2 instance which is registered with the
given id and for the given type or null if no subset with
this id could be found or new subsets are not supported |
java.lang.String |
getSubsetId(java.lang.String name,
int type)
Checks if a subset with the given name and type already exists for this hierarchy and returns its id. |
java.lang.String[] |
getSubsetIDs()
Returns the IDs of all locally and globally registered Subset2 s |
java.lang.String[] |
getSubsetIDs(int type)
Returns the IDs of all registered Subset2 s of given type |
java.lang.String |
getSubsetName(java.lang.String id)
Returns the name of the subset which is registered for the given id or null |
java.lang.String[] |
getSubsetNames()
Returns the names of all locally and globally registered Subset2 s |
java.lang.String[] |
getSubsetNames(int type)
Returns the names of all registered Subset2 s of given type |
Subset2[] |
getSubsets()
Returns all Subset2 s which are currently registered with this
hierarchy. |
Subset2[] |
getSubsets(int type)
Returns all Subset2 s of the given type which are registered with
this hierarchy. |
void |
getSubsets(int type,
SubsetLoadObserver observer)
|
void |
getSubsets(SubsetLoadObserver observer)
|
boolean |
hasSubsets(int type)
Checks if there are any subsets of the given type |
void |
remove(java.lang.String id,
int type)
Removes the subset specified by the given id and type. |
void |
remove(Subset2 subset)
Removes the given subset |
void |
reset()
Resets this SubsetHandler . |
void |
save(Subset2 subset)
Saves the given subset |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SubsetHandlerImpl(Dimension dimension)
SubsetHandlerImpl
instance for the given
dimension.
dimension
- the dimension to create the subset handler forMethod Detail |
---|
public final boolean canRead(int type)
SubsetHandler
canRead
in interface SubsetHandler
type
- one of the predefined subset type constants.
true
if user is allowed to read subsets of given
type, false
otherwisepublic final boolean canWrite(int type)
SubsetHandler
canWrite
in interface SubsetHandler
type
- one of the predefined subset type constants.
true
if user is allowed to write subsets of given
type, false
otherwisepublic final Dimension getDimension()
SubsetHandler
Dimension
to which this
SubsetHandler
is registered.
getDimension
in interface SubsetHandler
Dimension
of this SubsetHandler
.public final Hierarchy getHierarchy()
SubsetHandler
Hierarchy
to which this
SubsetHandler
is registered.
getHierarchy
in interface SubsetHandler
Hierarchy
of this SubsetHandler
.public final void reset()
SubsetHandler
SubsetHandler
. This will clear all internally
used caches too.
reset
in interface SubsetHandler
public final Subset2 addSubset(java.lang.String name, int type)
SubsetHandler
Subset2
with the given name and type to this hierarchy
addSubset
in interface SubsetHandler
name
- the name of the subsettype
- one of the defined subset type constants
public final Subset2 getSubset(java.lang.String id, int type)
SubsetHandler
Subset2
instance which is registered with the
given id and for the given type or null
if no subset with
this id could be found or new subsets are not supported
getSubset
in interface SubsetHandler
id
- the subset idtype
- one of the defined subset type constants
public final void getSubsets(SubsetLoadObserver observer)
public final Subset2[] getSubsets()
SubsetHandler
Subset2
s which are currently registered with this
hierarchy. This method tries to load all locally and globally defined
subsets. Subsets which cannot be loaded are ignored.
getSubsets
in interface SubsetHandler
public final void getSubsets(int type, SubsetLoadObserver observer)
public final Subset2[] getSubsets(int type)
SubsetHandler
Subset2
s of the given type which are registered with
this hierarchy. Subsets which cannot be loaded are ignored.
getSubsets
in interface SubsetHandler
type
- one of the defined subset type constants
public final java.lang.String getSubsetId(java.lang.String name, int type)
SubsetHandler
getSubsetId
in interface SubsetHandler
name
- a subset nametype
- one of the defined subset type constants
null
otherwisepublic final java.lang.String[] getSubsetIDs()
SubsetHandler
Subset2
s
getSubsetIDs
in interface SubsetHandler
public java.lang.String[] getSubsetIDs(int type)
SubsetHandler
Subset2
s of given type
getSubsetIDs
in interface SubsetHandler
type
- one of the defined subset type constants
public java.lang.String[] getSubsetNames()
SubsetHandler
Subset2
s
getSubsetNames
in interface SubsetHandler
public java.lang.String[] getSubsetNames(int type)
SubsetHandler
Subset2
s of given type
getSubsetNames
in interface SubsetHandler
type
- one of the defined subset type constants
public final java.lang.String getSubsetName(java.lang.String id)
SubsetHandler
null
getSubsetName
in interface SubsetHandler
id
- the subset id
null
if no name exists to given id or if new
subsets are not supportedpublic final boolean hasSubsets(int type)
SubsetHandler
hasSubsets
in interface SubsetHandler
type
- one of the defined subset type constants
true
if there are subsets of given type registered
or false
if notpublic void remove(Subset2 subset)
SubsetHandler
remove
in interface SubsetHandler
subset
- the subset to removepublic void remove(java.lang.String id, int type)
SubsetHandler
remove
in interface SubsetHandler
id
- the subset idtype
- the subset typepublic final void save(Subset2 subset)
SubsetHandler
save
in interface SubsetHandler
subset
- the subset to savepublic final Subset2 create(java.lang.String id, java.lang.String name, Hierarchy hierarchy, int type)
- API INTERNAL -
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |